diff options
Diffstat (limited to 'descriptions/api.github.com/api.github.com.json')
| -rw-r--r-- | descriptions/api.github.com/api.github.com.json | 5560 |
1 files changed, 4866 insertions, 694 deletions
diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 9175c423a..a0f460fff 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "0.0.5", + "version": "0.0.7", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -372,11 +372,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -528,11 +524,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -583,11 +575,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -621,11 +609,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -741,11 +725,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -1469,11 +1449,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -2393,7 +2369,1020 @@ } } }, - "/enterprises/{enterprise_id}/settings/billing/actions": { + "/enterprises/{enterprise}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an enterprise", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runner-groups-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-groups-enterprise" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-groups-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an enterprise", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#create-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "type": "string", + "enum": [ + "selected", + "all" + ] + }, + "selected_organization_ids": { + "description": "List of organization IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_organization_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an enterprise", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#get-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an enterprise", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#update-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", + "type": "string", + "enum": [ + "selected", + "all" + ], + "default": "all" + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-update-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an enterprise", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#delete-a-self-hosted-runner-group-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + "get": { + "summary": "List organization access to a self-hosted runner group in an enterprise", + "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-targets" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set organization access for a self-hosted runner group in an enterprise", + "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "List of organization IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + } + }, + "required": [ + "selected_organization_ids" + ] + }, + "example": { + "selected_organization_ids": [ + 32, + 91 + ] + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + "put": { + "summary": "Add organization access to a self-hosted runner group in an enterprise", + "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/org_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Remove organization access to a self-hosted runner group in an enterprise", + "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/org_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an enterprise", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set self-hosted runners in a group for an enterprise", + "description": "Replaces the list of self-hosted runners that that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#set-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "runners" + ] + }, + "example": { + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an enterprise", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", + "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/runner_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an enterprise", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/runner_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners": { + "get": { + "summary": "List self-hosted runners for an enterprise", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runners-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for an enterprise", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-runner-applications-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#list-runner-applications-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-application" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-application-items" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an enterprise", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterpises/octo-enterprise --token TOKEN\n```", + "operationId": "enterprise-admin/create-registration-token-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#create-a-registration-token-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an enterprise", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "operationId": "enterprise-admin/create-remove-token-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#create-a-remove-token-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token-2" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an enterprise", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#get-a-self-hosted-runner-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_id" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Delete a self-hosted runner from an enterprise", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/actions/#delete-self-hosted-runner-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/runner_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for an enterprise", "description": "**Warning:** The Billing API is currently in public beta and subject to change.\n\nGets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.", @@ -2407,7 +3396,7 @@ }, "parameters": [ { - "$ref": "#/components/parameters/enterprise-id" + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -2438,7 +3427,7 @@ } } }, - "/enterprises/{enterprise_id}/settings/billing/packages": { + "/enterprises/{enterprise}/settings/billing/packages": { "get": { "summary": "Get GitHub Packages billing for an enterprise", "description": "**Warning:** The Billing API is currently in public beta and subject to change.\n\nGets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nThe authenticated user must be an enterprise admin.", @@ -2452,7 +3441,7 @@ }, "parameters": [ { - "$ref": "#/components/parameters/enterprise-id" + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -2483,7 +3472,7 @@ } } }, - "/enterprises/{enterprise_id}/settings/billing/shared-storage": { + "/enterprises/{enterprise}/settings/billing/shared-storage": { "get": { "summary": "Get shared storage billing for an enterprise", "description": "**Warning:** The Billing API is currently in public beta and subject to change.\n\nGets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nThe authenticated user must be an enterprise admin.", @@ -2497,7 +3486,7 @@ }, "parameters": [ { - "$ref": "#/components/parameters/enterprise-id" + "$ref": "#/components/parameters/enterprise" } ], "responses": { @@ -4037,11 +5026,6 @@ "enabledForGitHubApps": true, "previews": [ { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" @@ -4231,11 +5215,6 @@ "previews": [ { "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions." } @@ -5664,6 +6643,10 @@ "none" ] }, + "members_can_create_pages": { + "type": "boolean", + "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. \nDefault: `true`. " + }, "blog": { "type": "string", "example": "\"http://github.blog\"" @@ -5740,10 +6723,732 @@ } } }, + "/orgs/{org}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nLists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#list-self-hosted-runner-groups-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-groups-org" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-groups-org" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nCreates a new self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#create-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nGets a specific self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-item" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nUpdates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nDeletes a self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nLists the repositories with access to a self-hosted runner group configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nReplaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#set-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "example": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nAdds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org`\nscope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/repository_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nRemoves a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/repository_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nLists self-hosted runners that are in a specific organization group.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "put": { + "summary": "Set self-hosted runners in a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nReplaces the list of self-hosted runners that are part of an organization runner group.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#set-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "runners" + ] + }, + "example": { + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nAdds a self-hosted runner to a runner group configured in an organization.\n\nYou must authenticate using an access token with the `admin:org`\nscope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#add-a-self-hosted-runner-to-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/runner_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nRemoves a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/self-hosted-runner-groups/#remove-a-self-hosted-runner-from-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/runner_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, "/orgs/{org}/actions/runners": { "get": { "summary": "List self-hosted runners for an organization", - "description": "**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.\n\nLists all self-hosted runners for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], @@ -5810,7 +7515,7 @@ "/orgs/{org}/actions/runners/downloads": { "get": { "summary": "List runner applications for an organization", - "description": "**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.\n\nLists binaries for the runner application that you can download and run. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], @@ -5858,7 +7563,7 @@ "/orgs/{org}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for an organization", - "description": "**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.\n\n\nReturns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate\nusing an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```", "tags": [ "actions" ], @@ -5903,7 +7608,7 @@ "/orgs/{org}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for an organization", - "description": "**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.\n\n\nReturns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The\ntoken expires after one hour. You must authenticate using an access token with the `admin:org` scope to use this\nendpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", "tags": [ "actions" ], @@ -5948,7 +7653,7 @@ "/orgs/{org}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for an organization", - "description": "**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.\n\nGets a specific self-hosted runner for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], @@ -5994,7 +7699,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from an organization", - "description": "**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.\n\nForces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], @@ -7298,11 +9003,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -7369,11 +9070,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "orgs", "subcategory": null @@ -7874,11 +9571,6 @@ "previews": [ { "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions." } @@ -14457,10 +16149,54 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get a repository's Actions permissions", + "description": "Gets the repository's permissions for running GitHub Actions. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the full `repo` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-permissions", + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-repo-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-repo-permissions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners for a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", "tags": [ "actions" ], @@ -14530,7 +16266,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", "tags": [ "actions" ], @@ -14677,7 +16413,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this", "tags": [ "actions" ], @@ -14726,7 +16462,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`", "tags": [ "actions" ], @@ -15647,7 +17383,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { "get": { "summary": "Get a workflow", - "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], @@ -15698,7 +17434,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { "post": { "summary": "Create a workflow dispatch event", - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", "operationId": "actions/create-workflow-dispatch", "tags": [ "actions" @@ -15770,7 +17506,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs", - "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" ], @@ -15855,7 +17591,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], @@ -19462,7 +21198,7 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `master`) and protected branches in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Lists all open code scanning alerts for the default branch (usually `master`) and protected branches in a repository. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint.", "tags": [ "code-scanning" ], @@ -19480,21 +21216,20 @@ }, { "name": "state", - "description": "Set to `closed` to list only closed code scanning alerts.", + "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", "in": "query", "required": false, "schema": { - "type": "string", - "default": "open" + "$ref": "#/components/schemas/code-scanning-alert/state" } }, { "name": "ref", - "description": "Returns a list of code scanning alerts for a specific brach reference. The `ref` must be formatted as `heads/<branch name>`.", "in": "query", + "description": "Set a full Git reference to list alerts for a specific branch. The `ref` must be formatted as `refs/heads/<branch name>`.", "required": false, "schema": { - "type": "string" + "$ref": "#/components/schemas/code-scanning-alert/ref" } } ], @@ -19506,12 +21241,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/code-scanning-alert" + "$ref": "#/components/schemas/code-scanning-alert/code-scanning-alert-items" } }, "examples": { "default": { - "$ref": "#/components/examples/code-scanning-alert-items" + "$ref": "#/components/examples/code-scanning-alert/code-scanning-alert-items" } } } @@ -19535,10 +21270,10 @@ } } }, - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_id}": { + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { "get": { "summary": "Get a code scanning alert", - "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe security `alert_id` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`.", + "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe security `alert_number` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`.", "tags": [ "code-scanning" ], @@ -19555,8 +21290,8 @@ "$ref": "#/components/parameters/repo" }, { - "name": "alert_id", - "description": "alert_id parameter", + "name": "alert_number", + "description": "alert_number parameter", "in": "path", "required": true, "schema": { @@ -19570,11 +21305,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/code-scanning-alert" + "$ref": "#/components/schemas/code-scanning-alert/code-scanning-alert" }, "examples": { "default": { - "$ref": "#/components/examples/code-scanning-alert" + "$ref": "#/components/examples/code-scanning-alert/code-scanning-alert" } } } @@ -19596,6 +21331,233 @@ "category": "code-scanning", "subcategory": null } + }, + "patch": { + "summary": "Update a code scanning alert", + "description": "Updates the status of a single code scanning alert. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/update-alert", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/code-scanning/#upload-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert_number" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/code-scanning-alert/set-state" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert/dismissed-reason" + } + }, + "required": [ + "state" + ] + }, + "example": { + "state": "dismissed", + "dismissed_reason": "false positive" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-alert/code-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert/code-scanning-alert-dismissed" + } + } + } + } + }, + "503": { + "description": "When code scanning isn't available you can try again at a later time" + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/analyses": { + "get": { + "summary": "List recent code scanning analyses for a repository", + "description": "List the details of recent code scanning analyses for a repository. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "operationId": "code-scanning/list-recent-analyses", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/code-scanning/#list-recent-analyses" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "in": "query", + "description": "Set a full Git reference to list alerts for a specific branch. The `ref` must be formatted as `refs/heads/<branch name>`.", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis/ref" + } + }, + { + "name": "tool_name", + "in": "query", + "description": "Set a single code scanning tool name to filter alerts by tool.", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis/tool-name" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-analysis/code-scanning-analysis" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-analysis/code-scanning-analysis-items" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs": { + "post": { + "summary": "Upload a SARIF file", + "description": "Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository.\nFor private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/upload-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/code-scanning/#upload-a-sarif-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_sha": { + "$ref": "#/components/schemas/code-scanning-analysis/commit-sha" + }, + "ref": { + "$ref": "#/components/schemas/code-scanning-analysis/ref" + }, + "sarif": { + "$ref": "#/components/schemas/code-scanning-analysis/sarif-file" + }, + "checkout_uri": { + "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri" + }, + "started_at": { + "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date", + "type": "string" + }, + "tool_name": { + "$ref": "#/components/schemas/code-scanning-analysis/tool-name" + } + }, + "required": [ + "commit_sha", + "ref", + "sarif", + "tool_name" + ] + }, + "example": { + "commit_sha": "9a450a043b9038ba86722926570d2312cff6aba8", + "ref": "refs/heads/main", + "sarif": "REPLACE_ME", + "tool_name": "codeql" + } + } + } + }, + "responses": { + "202": { + "description": "response" + }, + "404": { + "description": "Response if `commit_sha` or `ref` cannot be found" + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning." + } } }, "/repos/{owner}/{repo}/collaborators": { @@ -20382,7 +22344,7 @@ "/repos/{owner}/{repo}/commits": { "get": { "summary": "List commits", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\nThese are the possible values for `reason` in the `verification` object:\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -20800,7 +22762,7 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\nYou can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\nYou can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n**Signature verification object**\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\nThese are the possible values for `reason` in the `verification` object:\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -21303,7 +23265,7 @@ "/repos/{owner}/{repo}/compare/{base}...{head}": { "get": { "summary": "Compare two commits", - "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `<USERNAME>:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://developer.github.com/v3/repos/commits/#list-commits) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `<USERNAME>:branch`.\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n**Working with large comparisons**\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://developer.github.com/v3/repos/commits/#list-commits) to enumerate all commits in the range.\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.\n**Signature verification object**\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\nThese are the possible values for `reason` in the `verification` object:\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -22216,11 +24178,6 @@ "previews": [ { "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, "name": "ant-man", "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```" } @@ -22546,11 +24503,6 @@ "previews": [ { "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, "name": "flash", "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```" }, @@ -23000,7 +24952,7 @@ "/repos/{owner}/{repo}/git/commits": { "post": { "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\nIn this example, the payload of the signature would be:\n\n\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n**Signature verification object**\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\nThese are the possible values for `reason` in the `verification` object:\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -23145,7 +25097,7 @@ "/repos/{owner}/{repo}/git/commits/{commit_sha}": { "get": { "summary": "Get a commit", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n**Signature verification object**\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\nThese are the possible values for `reason` in the `verification` object:\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -23553,7 +25505,7 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.\n**Signature verification object**\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\nThese are the possible values for `reason` in the `verification` object:\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -23679,7 +25631,7 @@ "/repos/{owner}/{repo}/git/tags/{tag_sha}": { "get": { "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\nThese are the possible values for `reason` in the `verification` object:\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -25066,11 +27018,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -25556,11 +27504,6 @@ "previews": [ { "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions." } @@ -25858,11 +27801,6 @@ "previews": [ { "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions." } @@ -26289,11 +28227,6 @@ "required": false, "name": "starfox", "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" - }, - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" } ], "category": "issues", @@ -26364,16 +28297,6 @@ "required": false, "name": "starfox", "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" - }, - { - "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" } ], "category": "issues", @@ -26980,11 +28903,6 @@ "required": false, "name": "starfox", "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" - }, - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" } ], "category": "issues", @@ -27401,11 +29319,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" - } + ], "category": "issues", "subcategory": null @@ -29225,7 +31139,7 @@ }, "post": { "summary": "Create a GitHub Pages site", - "description": "", + "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", "tags": [ "repos" ], @@ -29247,29 +31161,37 @@ "application/json": { "schema": { "type": "object", + "description": "The source branch and directory used to publish your Pages site.", "properties": { "source": { "type": "object", "properties": { "branch": { "type": "string", - "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", - "enum": [ - "master", - "gh-pages" - ] + "description": "The repository branch used to publish your site's source files." }, "path": { "type": "string", - "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`." + "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", + "enum": [ + "/", + "/docs" + ], + "default": "/" } - } + }, + "required": [ + "branch" + ] } - } + }, + "required": [ + "source" + ] }, "example": { "source": { - "branch": "master", + "branch": "main", "path": "/docs" } } @@ -29318,7 +31240,7 @@ }, "put": { "summary": "Update information about a GitHub Pages site", - "description": "", + "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", "tags": [ "repos" ], @@ -29359,22 +31281,39 @@ }, { "type": "object", + "description": "Update the source for the repository. Must include the branch name and path.", "properties": { "branch": { - "type": "string" + "type": "string", + "description": "The repository branch used to publish your site's source files." }, "path": { - "type": "string" + "type": "string", + "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", + "enum": [ + "/", + "/docs" + ] } - } + }, + "required": [ + "branch", + "path" + ] } ] } - } + }, + "required": [ + "source" + ] }, "example": { "cname": "octocatblog.com", - "source": "master /docs" + "source": { + "branch": "main", + "path": "/" + } } } } @@ -29971,11 +31910,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" - } + ], "category": "pulls", "subcategory": null @@ -30085,11 +32020,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" - } + ], "category": "pulls", "subcategory": null @@ -30661,11 +32592,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" - } + ], "category": "pulls", "subcategory": null @@ -30761,11 +32688,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "sailor-v", - "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```" - } + ], "category": "pulls", "subcategory": null @@ -34854,6 +36777,958 @@ } } }, + "/scim/v2/enterprises/{enterprise}/Groups": { + "get": { + "summary": "List provisioned SCIM groups for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/list-provisioned-groups-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#list-provisioned-scim groups-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/start_index" + }, + { + "$ref": "#/components/parameters/count" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-group-list-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group-list" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "post": { + "summary": "Provision a SCIM enterprise group and invite users", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#provision-a-scim-enterprise-group-and-invite-users" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + "get": { + "summary": "Get SCIM provisioning information for an enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#get-scim-provisioning-information-for-an-enterprise group" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "put": { + "summary": "Set SCIM information for a provisioned enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#set-scim-information-for-a-provisioned-enterprise-group" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "patch": { + "summary": "Update an attribute for a SCIM enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "operationId": "enterprise-admin/update-attribute-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#update-an-attribute-for-a-scim-enterprise-group" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "Operations": { + "type": "array", + "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "items": { + "type": "object" + } + } + }, + "required": [ + "schemas", + "Operations" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "remove", + "path": "members", + "value": [ + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group-2" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "delete": { + "summary": "Delete a SCIM group from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-scim-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#delete-a-scim-group-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, + "/scim/v2/enterprises/{enterprise}/Users": { + "get": { + "summary": "List SCIM provisioned identities for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nRetrieves a paginated list of all provisioned enterprise members, including pending invitations.\n\nWhen a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:\n - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future.\n - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).\n - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.\n\nThe returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:\n\n1. The user is granted access by the IdP and is not a member of the GitHub enterprise.\n\n1. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.\n\n1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account:\n - If the user signs in, their GitHub account is linked to this entry.\n - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place.", + "operationId": "enterprise-admin/list-provisioned-identities-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#list-scim-provisioned-identities-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/start_index" + }, + { + "$ref": "#/components/parameters/count" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-user-list-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user-list" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "post": { + "summary": "Provision and invite a SCIM enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision enterprise membership for a user, and send organization invitation emails to the email address.\n\nYou can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#provision-and-invite-a-scim-enterprise-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "userName": { + "type": "string", + "description": "The username for the user." + }, + "name": { + "type": "object", + "properties": { + "givenName": { + "type": "string", + "description": "The first name of the user." + }, + "familyName": { + "type": "string", + "description": "The last name of the user." + } + }, + "required": [ + "givenName", + "familyName" + ] + }, + "emails": { + "type": "array", + "description": "List of user emails.", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The email address." + }, + "type": { + "type": "string", + "description": "The type of email address." + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address." + } + }, + "required": [ + "value", + "type", + "primary" + ] + } + }, + "groups": { + "type": "array", + "description": "List of SCIM group IDs the user is a member of.", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + } + } + }, + "required": [ + "schemas", + "userName", + "name", + "emails" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "userName": "mona.octocat@okta.example.com", + "name": { + "familyName": "Octocat", + "givenName": "Mona" + }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + } + ], + "groups": [ + { + "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + "get": { + "summary": "Get SCIM provisioning information for an enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#get-scim-provisioning-information-for-an-enterprise-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_user_id" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "put": { + "summary": "Set SCIM information for a provisioned enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n**Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#set-scim-information-for-a-provisioned-enterprise-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_user_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "userName": { + "type": "string", + "description": "The username for the user." + }, + "name": { + "type": "object", + "properties": { + "givenName": { + "type": "string", + "description": "The first name of the user." + }, + "familyName": { + "type": "string", + "description": "The last name of the user." + } + }, + "required": [ + "givenName", + "familyName" + ] + }, + "emails": { + "type": "array", + "description": "List of user emails.", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The email address." + }, + "type": { + "type": "string", + "description": "The type of email address." + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address." + } + }, + "required": [ + "value", + "type", + "primary" + ] + } + }, + "groups": { + "type": "array", + "description": "List of SCIM group IDs the user is a member of.", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + } + } + }, + "required": [ + "schemas", + "userName", + "name", + "emails" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "userName": "mona.octocat@okta.example.com", + "name": { + "familyName": "Octocat", + "givenName": "Mona" + }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + } + ], + "groups": [ + { + "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "patch": { + "summary": "Update an attribute for a SCIM enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated `:scim_user_id`.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "operationId": "enterprise-admin/update-attribute-for-enterprise-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#update-an-attribute-for-a-scim-enterprise-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_user_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "Operations": { + "type": "array", + "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "items": { + "type": "object" + } + } + }, + "required": [ + "schemas", + "Operations" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "add", + "path": "emails", + "value": [ + { + "value": "monalisa@octocat.github.com", + "type": "home" + } + ] + }, + { + "op": "replace", + "path": "name.givenName", + "value": "Monalisa" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user-2" + } + } + } + } + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "delete": { + "summary": "Delete a SCIM user from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-user-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/enterprise-admin/scim/#delete-a-scim-user-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_user_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, "/scim/v2/organizations/{org}/Users": { "get": { "summary": "List SCIM provisioned identities", @@ -39979,11 +42854,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": "installations" @@ -40063,11 +42934,6 @@ "enabledForGitHubApps": false, "previews": [ { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" @@ -40122,11 +42988,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": "installations" @@ -40175,11 +43037,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": "installations" @@ -40299,11 +43157,6 @@ "previews": [ { "required": false, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - }, - { - "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions." } @@ -43082,11 +45935,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "machine-man", - "note": "To access the API with your GitHub App, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" - } + ], "category": "apps", "subcategory": null @@ -44261,7 +47110,7 @@ }, "single_file_name": { "type": "string", - "example": "config.yml", + "example": "config.yaml", "nullable": true }, "app_slug": { @@ -45367,7 +48216,7 @@ }, "single_file_name": { "type": "string", - "example": "config.yml", + "example": "config.yaml", "nullable": true }, "repositories_url": { @@ -45574,6 +48423,232 @@ "body" ] }, + "runner-groups-enterprise": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + } + } + }, + "organization-simple": { + "title": "Organization Simple", + "description": "Organization Simple", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "runner-application": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { + "type": "string" + }, + "architecture": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "filename": { + "type": "string" + } + } + }, + "authentication-token": { + "title": "Authentication Token", + "description": "Authentication Token", + "type": "object", + "properties": { + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } + }, + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "single_file": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + } + }, + "required": [ + "token", + "expires_at" + ] + }, "actions-billing-usage": { "type": "object", "properties": { @@ -48060,79 +51135,6 @@ "subscribed" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "Organization Simple", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, "organization-full": { "title": "Organization Full", "description": "Organization Full", @@ -48343,6 +51345,10 @@ "type": "boolean", "example": true }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, "updated_at": { "type": "string", "format": "date-time" @@ -48373,106 +51379,31 @@ "updated_at" ] }, - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "runner-groups-org": { "type": "object", "properties": { "id": { - "description": "The id of the runner.", - "type": "integer", - "example": 5 + "type": "number" }, "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - } - }, - "required": [ - "id", - "name", - "os", - "status" - ] - }, - "runner-application": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { "type": "string" }, - "architecture": { + "visibility": { "type": "string" }, - "download_url": { - "type": "string" + "default": { + "type": "boolean" }, - "filename": { + "selected_repositories_url": { "type": "string" - } - } - }, - "authentication-token": { - "title": "Authentication Token", - "description": "Authentication Token", - "type": "object", - "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" - }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "$ref": "#/components/schemas/repository" - } }, - "single_file": { - "type": "string", - "example": "config.yml", - "nullable": true + "runners_url": { + "type": "string" }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] + "inherited": { + "type": "boolean" } - }, - "required": [ - "token", - "expires_at" - ] + } }, "organization-actions-secret": { "title": "Actions Secret for an Organization", @@ -50876,6 +53807,9 @@ }, "integration_manifest": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_upload": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -51432,7 +54366,8 @@ "nullable": true }, "expires_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "updated_at": { "type": "string", @@ -51599,6 +54534,23 @@ "check_run_url" ] }, + "actions-repo-permissions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions are allowed to run on this repo." + }, + "allowed_actions": { + "type": "string", + "description": "Which GitHub Actions are allowed to run on this repo when enabled is true. Either 'all', 'local_only' or 'selected'." + }, + "selected_actions_url": { + "type": "string", + "description": "The URL of the selected GitHub Actions that can run. Only when allowed_actions is selected." + } + } + }, "pull-request-minimal": { "title": "Pull Request Minimal", "type": "object", @@ -51858,7 +54810,7 @@ "workflow_url": { "description": "The URL to the workflow.", "type": "string", - "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yml" + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" }, "head_commit": { "$ref": "#/components/schemas/simple-commit" @@ -51993,7 +54945,7 @@ }, "path": { "type": "string", - "example": "ruby.yml" + "example": "ruby.yaml" }, "state": { "type": "string", @@ -52019,7 +54971,7 @@ }, "html_url": { "type": "string", - "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yml" + "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" }, "badge_url": { "type": "string", @@ -53403,82 +56355,292 @@ } }, "code-scanning-alert": { - "title": "Code Scanning Alert", - "description": "Code Scanning Alert", - "type": "object", - "properties": { - "number": { - "type": "integer" - }, - "rule_id": { - "description": "A unique identifier for the rule used to detect the alert.", - "example": "py/unused-import", - "type": "string" - }, - "rule_severity": { - "description": "The severity of the alert.", - "example": "warning", - "type": "string", - "enum": [ - "none", - "note", - "warning", - "error" - ] - }, - "rule_description": { - "description": "A short description of the rule used to detect the alert.", - "example": "Unused import", - "type": "string" - }, - "tool": { - "description": "The name of the tool used to detect the alert.", - "example": "CodeQL", - "type": "string", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "open": { - "description": "Whether or not the alert is open.", - "example": true, - "type": "boolean" - }, - "closed_by": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "url": { - "example": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/5", - "type": "string" - }, - "html_url": { - "example": "https://github.com/github/hello-world/security/code-scanning/5", - "type": "string" - }, - "closed_reason": { - "type": "string", - "example": "false positive", - "enum": [ - "false positive", - "won't fix", - "used in tests" - ], - "nullable": true + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/<branch name>`." + }, + "number": { + "type": "integer", + "description": "The code scanning alert number.", + "readOnly": true, + "nullable": false + }, + "created-at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html-url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "dismissed-by": { + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "enum": [ + null + ] + } + ] + }, + "dismissed-at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed-reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + } + } + }, + "code-scanning-alert-items": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/code-scanning-alert/number" + }, + "created_at": { + "$ref": "#/components/schemas/code-scanning-alert/created-at" + }, + "url": { + "$ref": "#/components/schemas/code-scanning-alert/url" + }, + "html_url": { + "$ref": "#/components/schemas/code-scanning-alert/html-url" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert/state" + }, + "dismissed_by": { + "$ref": "#/components/schemas/code-scanning-alert/dismissed-by" + }, + "dismissed_at": { + "$ref": "#/components/schemas/code-scanning-alert/dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert/dismissed-reason" + }, + "rule": { + "$ref": "#/components/schemas/code-scanning-alert/rule" + }, + "tool": { + "$ref": "#/components/schemas/code-scanning-analysis/tool" + } + } + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "instances": { + "nullable": true, + "type": "array", + "properties": { + "ref": { + "$ref": "#/components/schemas/code-scanning-alert/ref" + }, + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis/analysis-key" + }, + "environment": { + "$ref": "#/components/schemas/code-scanning-alert/environment" + }, + "matrix_vars": { + "nullable": true, + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert/state" + } } + }, + "code-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/code-scanning-alert/number" + }, + "created_at": { + "$ref": "#/components/schemas/code-scanning-alert/created-at" + }, + "url": { + "$ref": "#/components/schemas/code-scanning-alert/url" + }, + "html_url": { + "$ref": "#/components/schemas/code-scanning-alert/html-url" + }, + "instances": { + "$ref": "#/components/schemas/code-scanning-alert/instances" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert/state" + }, + "dismissed_by": { + "$ref": "#/components/schemas/code-scanning-alert/dismissed-by" + }, + "dismissed_at": { + "$ref": "#/components/schemas/code-scanning-alert/dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert/dismissed-reason" + }, + "rule": { + "$ref": "#/components/schemas/code-scanning-alert/rule" + }, + "tool": { + "$ref": "#/components/schemas/code-scanning-analysis/tool" + } + } + }, + "set-state": { + "description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "type": "string", + "enum": [ + "open", + "dismissed" + ] + } + }, + "code-scanning-analysis": { + "tool-name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis alert." + }, + "tool": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/code-scanning-analysis/tool-name" + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to detect the alert." + } + } + }, + "analysis-key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "ref": { + "type": "string", + "description": "The full Git reference of the code scanning analysis file, formatted as `refs/heads/<branch name>`." + }, + "commit-sha": { + "description": "The commit SHA of the code scanning analysis file.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "created-at": { + "type": "string", + "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which this analysis was performed." + }, + "code-scanning-analysis": { + "type": "object", + "properties": { + "commit_sha": { + "$ref": "#/components/schemas/code-scanning-analysis/commit-sha" + }, + "ref": { + "$ref": "#/components/schemas/code-scanning-analysis/ref" + }, + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis/analysis-key" + }, + "created_at": { + "$ref": "#/components/schemas/code-scanning-analysis/created-at" + }, + "tool_name": { + "$ref": "#/components/schemas/code-scanning-analysis/tool-name" + }, + "error": { + "type": "string", + "example": "error reading field xyz" + }, + "environment": { + "$ref": "#/components/schemas/code-scanning-analysis/environment" + } + } + }, + "sarif-file": { + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string.", + "type": "string" } }, "collaborator": { @@ -58454,7 +61616,7 @@ }, "path": { "description": "The relative path of the file to which the comment applies.", - "example": "config/database.yml", + "example": "config/database.yaml", "type": "string" }, "position": { @@ -59607,6 +62769,320 @@ "views" ] }, + "scim-group-list-enterprise": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalResults": { + "type": "number" + }, + "itemsPerPage": { + "type": "number" + }, + "startIndex": { + "type": "number" + }, + "Resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + } + } + } + } + }, + "scim-enterprise-group": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + } + }, + "scim-user-list-enterprise": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalResults": { + "type": "number" + }, + "itemsPerPage": { + "type": "number" + }, + "startIndex": { + "type": "number" + }, + "Resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string" + }, + "userName": { + "type": "string" + }, + "name": { + "type": "object", + "properties": { + "givenName": { + "type": "string" + }, + "familyName": { + "type": "string" + } + } + }, + "emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + } + }, + "active": { + "type": "boolean" + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + } + } + } + } + }, + "scim-enterprise-user": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string" + }, + "userName": { + "type": "string" + }, + "name": { + "type": "object", + "properties": { + "givenName": { + "type": "string" + }, + "familyName": { + "type": "string" + } + } + }, + "emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "type": { + "type": "string" + }, + "primary": { + "type": "boolean" + } + } + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + } + }, + "active": { + "type": "boolean" + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + } + }, "scim-user": { "title": "SCIM /Users", "description": "SCIM /Users provisioning endpoints", @@ -61995,7 +65471,7 @@ "push", "pull_request" ], - "single_file_name": "config.yml", + "single_file_name": "config.yaml", "repository_selection": "selected", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", @@ -62041,7 +65517,7 @@ "push", "pull_request" ], - "single_file_name": "config.yml", + "single_file_name": "config.yaml", "repository_selection": "selected", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", @@ -62425,6 +65901,213 @@ "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" } }, + "runner-groups-enterprise": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners" + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners" + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners" + } + ] + } + }, + "runner-group-enterprise": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners" + } + }, + "runner-group-update-enterprise": { + "value": { + "id": 2, + "name": "Expensive hardware runners", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners" + } + }, + "organization-targets": { + "value": { + "total_count": 1, + "organizations": [ + { + "login": "octocat", + "id": 161335, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + }, + "runner-paginated": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + }, + "runner-application-items": { + "value": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ] + }, + "authentication-token": { + "value": { + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" + } + }, + "authentication-token-2": { + "value": { + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" + } + }, + "runner": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + }, "actions-billing-usage": { "value": { "total_minutes_used": 305, @@ -63655,7 +67338,8 @@ "members_allowed_repository_creation_type": "all", "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false + "members_can_create_internal_repositories": false, + "members_can_create_pages": true } }, "organization-full-response-with-git-hub-plan-information": { @@ -63747,80 +67431,191 @@ "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, + "members_can_create_pages": true, "updated_at": "2014-03-03T18:58:10Z" } }, - "runner-paginated": { + "runner-groups-org": { "value": { - "total_count": 2, - "runners": [ + "total_count": 3, + "runner_groups": [ { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online" + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false }, { - "id": 24, - "name": "iMac", - "os": "macos", - "status": "offline" + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false } ] } }, - "runner-application-items": { - "value": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", - "filename": "actions-runner-osx-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", - "filename": "actions-runner-linux-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm-2.164.0.tar.gz" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", - "filename": "actions-runner-win-x64-2.164.0.zip" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" - } - ] - }, - "authentication-token": { + "runner-group": { "value": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false } }, - "authentication-token-2": { + "runner-group-item": { "value": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false } }, - "runner": { + "repository-paginated": { "value": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online" + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] } }, "organization-actions-secret-paginated": { @@ -66142,6 +69937,11 @@ "limit": 5000, "remaining": 4999, "reset": 1551806725 + }, + "code_scanning_upload": { + "limit": 500, + "remaining": 499, + "reset": 1551806725 } }, "rate": { @@ -67177,6 +70977,19 @@ "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" } }, + "actions-repo-permissions": { + "value": [ + { + "enabled": "true" + }, + { + "allowed_actions": "selected" + }, + { + "selected_actions_url": "https://api.github.com/repos/octo-org/octo-repo/actions/permissions/selected-actions" + } + ] + }, "workflow-run-paginated": { "value": { "total_count": 1, @@ -67208,7 +71021,7 @@ "head_commit": { "id": "acb5820ced9479c074f688cc328bf03f341a511d", "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", - "message": "Create linter.yml", + "message": "Create linter.yaml", "timestamp": "2020-01-22T19:33:05Z", "author": { "name": "Octo Cat", @@ -67387,7 +71200,7 @@ "head_commit": { "id": "acb5820ced9479c074f688cc328bf03f341a511d", "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", - "message": "Create linter.yml", + "message": "Create linter.yaml", "timestamp": "2020-01-22T19:33:05Z", "author": { "name": "Octo Cat", @@ -67691,7 +71504,7 @@ "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", "name": "CI", - "path": ".github/workflows/blank.yml", + "path": ".github/workflows/blank.yaml", "state": "active", "created_at": "2020-01-08T23:48:37.000-08:00", "updated_at": "2020-01-08T23:50:21.000-08:00", @@ -67703,7 +71516,7 @@ "id": 269289, "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==", "name": "Linter", - "path": ".github/workflows/linter.yml", + "path": ".github/workflows/linter.yaml", "state": "active", "created_at": "2020-01-08T23:48:37.000-08:00", "updated_at": "2020-01-08T23:50:21.000-08:00", @@ -67719,7 +71532,7 @@ "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", "name": "CI", - "path": ".github/workflows/blank.yml", + "path": ".github/workflows/blank.yaml", "state": "active", "created_at": "2020-01-08T23:48:37.000-08:00", "updated_at": "2020-01-08T23:50:21.000-08:00", @@ -68951,48 +72764,222 @@ ] } }, - "code-scanning-alert-items": { - "value": [ - { - "number": 42, - "rule_id": "js/trivial-conditional", - "rule_severity": "warning", - "rule_description": "Useless conditional", - "tool": "CodeQL", - "created_at": "2020-05-06T12:00:00Z", - "open": true, - "closed_by": null, - "closed_at": null, - "url": "https://api.github.com/repos/Octo-org/octo-repo/code-scanning/alerts/25", - "html_url": "https://github.com/Octo-org/octo-repo/security/code-scanning/25" - }, - { - "number": 43, - "rule_id": "js/useless-expression", - "rule_severity": "warning", - "rule_description": "Expression has no effect", - "tool": "CodeQL", - "created_at": "2020-05-06T12:00:00Z", - "open": true, - "closed_by": null, - "closed_at": null, - "url": "https://api.github.com/repos/Octo-org/octo-repo/code-scanning/alerts/88", - "html_url": "https://github.com/Octo-org/octo-repo/security/code-scanning/88" + "code-scanning-alert": { + "code-scanning-alert-items": { + "value": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/github/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction" + }, + "tool": { + "name": "CodeQL command-line toolchain", + "version": null + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/dsp-testing/github/hello-world/code-scanning/3", + "state": "open", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction" + }, + "tool": { + "name": "CodeQL command-line toolchain", + "version": null + } + } + ] + }, + "code-scanning-alert": { + "value": { + "number": 22, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/22", + "html_url": "https://github.com/github/hello-world/code-scanning/22", + "instances": [ + { + "ref": "refs/heads/codeql-analysis-yml", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": { + }, + "state": "fixed" + }, + { + "ref": "refs/pull/3740/head", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": { + }, + "state": "fixed" + } + ], + "state": "fixed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/polynomial-redos", + "severity": "warning", + "description": "Polynomial regular expression used on uncontrolled data" + }, + "tool": { + "name": "CodeQL command-line toolchain", + "version": null + } } - ] + }, + "code-scanning-alert-dismissed": { + "value": { + "number": 22, + "created_at": "2020-08-25T21:28:36Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/22", + "html_url": "https://github.com/github/hello-world/code-scanning/22", + "instances": [ + { + "ref": "refs/heads/codeql-analysis-yml", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": { + }, + "state": "dismissed" + }, + { + "ref": "refs/pull/3740/head", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": { + }, + "state": "dismissed" + } + ], + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-09-02T22:34:56Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/polynomial-redos", + "severity": "warning", + "description": "Polynomial regular expression used on uncontrolled data" + }, + "tool": { + "name": "CodeQL command-line toolchain", + "version": null + } + } + } }, - "code-scanning-alert": { - "value": { - "rule_id": "js/useless-expression", - "rule_severity": "warning", - "rule_description": "Expression has no effect", - "tool": "CodeQL", - "created_at": "2020-05-06T12:00:00Z", - "open": true, - "closed_by": null, - "closed_at": null, - "url": "https://api.github.com/repos/Octo-org/octo-repo/code-scanning/alerts/88", - "html_url": "https://github.com/Octo-org/octo-repo/security/code-scanning/88" + "code-scanning-analysis": { + "code-scanning-analysis-items": { + "value": [ + { + "ref": "refs/heads/master", + "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "tool_name": "CodeQL command-line toolchain", + "environment": "{}", + "error": "", + "created_at": "2020-08-27T15:05:21Z" + }, + { + "ref": "refs/heads/my-branch", + "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", + "analysis_key": ".github/workflows/shiftleft.yml:build", + "tool_name": "Python Security Analysis", + "environment": "{}", + "error": "", + "created_at": "2020-08-31T22:46:44Z" + } + ] } }, "collaborator-items": { @@ -75812,6 +79799,258 @@ } ] }, + "scim-enterprise-group-list": { + "value": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + }, + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd", + "externalId": null, + "displayName": "octo-docs-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T16:28:01.000+10:00", + "lastModified": "2020-06-09T16:28:01.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd" + } + } + ] + } + }, + "scim-enterprise-group": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + }, + "scim-enterprise-group-2": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + }, + "scim-enterprise-user-list": { + "value": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "externalId": "00dowz5dr9oSfDFRA0h7", + "userName": "octocat@github.com", + "name": { + "givenName": "Mona", + "familyName": "Octocat" + }, + "emails": [ + { + "value": "octocat@github.com", + "primary": true, + "type": "work" + } + ], + "groups": [ + { + "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" + } + ], + "active": true, + "meta": { + "resourceType": "User", + "created": "2020-05-30T04:02:34.000+10:00", + "lastModified": "2020-05-30T04:05:04.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + } + }, + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5", + "externalId": "sdfoiausdofiua", + "userName": "hubot@example.com", + "name": { + "givenName": "hu", + "familyName": "bot" + }, + "emails": [ + { + "value": "hubot@example.com", + "type": "work", + "primary": true + } + ], + "groups": [ + + ], + "active": true, + "meta": { + "resourceType": "User", + "created": "2020-06-05T08:29:40.000+10:00", + "lastModified": "2020-06-05T08:30:19.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5" + } + } + ] + } + }, + "scim-enterprise-user": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "externalId": "00dowz5dr9oSfDFRA0h7", + "userName": "mona.octocat@okta.example.com", + "name": { + "givenName": "Mona", + "familyName": "Octocat" + }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + } + ], + "groups": [ + { + "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" + } + ], + "active": true, + "meta": { + "resourceType": "User", + "created": "2017-03-09T16:11:13-05:00", + "lastModified": "2017-03-09T16:11:13-05:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + } + } + }, + "scim-enterprise-user-2": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "externalId": "00dowz5dr9oSfDFRA0h7", + "userName": "mona.octocat@okta.example.com", + "name": { + "givenName": "Monalisa", + "familyName": "Octocat" + }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + }, + { + "value": "monalisa@octocat.github.com", + "type": "home" + } + ], + "groups": [ + { + "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" + } + ], + "active": true, + "meta": { + "resourceType": "User", + "created": "2017-03-09T16:11:13-05:00", + "lastModified": "2017-03-09T16:11:13-05:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + } + } + }, "scim-user-list-response-with-filter": { "summary": "Response with filter", "value": { @@ -76958,7 +81197,7 @@ "push", "pull_request" ], - "single_file_name": "config.yml", + "single_file_name": "config.yaml", "repository_selection": "all", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", @@ -77001,7 +81240,7 @@ "push", "pull_request" ], - "single_file_name": "config.yml", + "single_file_name": "config.yaml", "repository_selection": "all", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", @@ -77010,135 +81249,6 @@ ] } }, - "repository-paginated": { - "value": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ] - } - }, "key-items": { "value": [ { @@ -78664,8 +82774,8 @@ "type": "integer" } }, - "enterprise-id": { - "name": "enterprise_id", + "enterprise": { + "name": "enterprise", "description": "Unique identifier of the GitHub Enterprise Cloud instance.", "in": "path", "required": true, @@ -78673,6 +82783,33 @@ "type": "string" } }, + "runner_group_id": { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "org_id": { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "runner_id": { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "gist_id": { "name": "gist_id", "description": "gist_id parameter", @@ -78808,9 +82945,8 @@ "type": "string" } }, - "runner_id": { - "name": "runner_id", - "description": "runner_id parameter", + "repository_id": { + "name": "repository_id", "in": "path", "required": true, "schema": { @@ -79053,6 +83189,15 @@ ] } }, + "alert_number": { + "name": "alert_number", + "in": "path", + "description": "The code scanning alert number.", + "required": true, + "schema": { + "$ref": "#/components/schemas/code-scanning-alert/number" + } + }, "commit_sha": { "name": "commit_sha", "description": "commit_sha+ parameter", @@ -79147,6 +83292,33 @@ "default": "day" } }, + "start_index": { + "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "count": { + "name": "count", + "description": "Used for pagination: the number of results to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "scim_group_id": { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "scim_user_id": { "name": "scim_user_id", "description": "scim_user_id parameter", |