diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 745bfaf086..ab8bc58804 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": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -2359,6 +2359,387 @@ } } }, + "/enterprises/{enterprise}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-enterprise-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-enterprise-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "$ref": "#/components/schemas/enabled-organizations" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + } + }, + "required": [ + "enabled_organizations" + ] + }, + "example": { + "enabled_organizations": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations": { + "get": { + "summary": "List selected organizations enabled for GitHub Actions in an enterprise", + "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-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" + }, + "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 selected organizations enabled for GitHub Actions in an enterprise", + "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "List of organization IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + } + }, + "required": [ + "selected_organization_ids" + ] + }, + "example": { + "selected_organization_ids": [ + 32, + 91 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + "put": { + "summary": "Enable a selected organization for GitHub Actions in an enterprise", + "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/org_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Disable a selected organization for GitHub Actions in an enterprise", + "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$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/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an enterprise", + "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set allowed actions for an enterprise", + "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, "/enterprises/{enterprise}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an enterprise", @@ -6710,6 +7091,387 @@ } } }, + "/orgs/{org}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-organization-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-organization-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "$ref": "#/components/schemas/enabled-repositories" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + } + }, + "required": [ + "enabled_repositories" + ] + }, + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-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" + }, + "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": "permissions" + } + }, + "put": { + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "example": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/enable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an organization", + "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-allowed-actions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions for an organization", + "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-allowed-actions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an organization", @@ -16132,6 +16894,208 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-repository-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-repository-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "$ref": "#/components/schemas/actions-enabled" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + } + }, + "required": [ + "enabled" + ] + }, + "example": { + "enabled": true, + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for a repository", + "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions for a repository", + "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", @@ -48365,6 +49329,139 @@ "body" ] }, + "enabled-organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed-actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected-actions-url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + }, + "actions-enterprise-permissions": { + "type": "object", + "properties": { + "enabled_organizations": { + "$ref": "#/components/schemas/enabled-organizations" + }, + "selected_organizations_url": { + "type": "string", + "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + } + } + }, + "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" + ] + }, + "selected-actions": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + } + }, "runner-groups-enterprise": { "type": "object", "properties": { @@ -48388,79 +49485,6 @@ } } }, - "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", @@ -51321,6 +52345,33 @@ "updated_at" ] }, + "enabled-repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "actions-organization-permissions": { + "type": "object", + "properties": { + "enabled_repositories": { + "$ref": "#/components/schemas/enabled-repositories" + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + } + } + }, "runner-groups-org": { "type": "object", "properties": { @@ -54316,6 +55367,24 @@ "check_run_url" ] }, + "actions-enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "actions-repository-permissions": { + "type": "object", + "properties": { + "enabled": { + "$ref": "#/components/schemas/actions-enabled" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + } + } + }, "pull-request-minimal": { "title": "Pull Request Minimal", "type": "object", @@ -65662,6 +66731,44 @@ "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()" } }, + "actions-enterprise-permissions": { + "value": { + "enabled_organizations": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" + } + }, + "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" + } + ] + } + }, + "selected-actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + }, "runner-groups-enterprise": { "value": { "total_count": 3, @@ -65711,27 +66818,6 @@ "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, @@ -67196,58 +68282,11 @@ "updated_at": "2014-03-03T18:58:10Z" } }, - "runner-groups-org": { + "actions-organization-permissions": { "value": { - "total_count": 3, - "runner_groups": [ - { - "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": 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-group": { - "value": { - "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-group-item": { - "value": { - "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 + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } }, "repository-paginated": { @@ -67379,6 +68418,60 @@ ] } }, + "runner-groups-org": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "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": 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-group": { + "value": { + "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-group-item": { + "value": { + "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 + } + }, "organization-actions-secret-paginated": { "value": { "total_count": 3, @@ -70738,6 +71831,13 @@ "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" } }, + "actions-repository-permissions": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + } + }, "workflow-run-paginated": { "value": { "total_count": 1, @@ -82528,25 +83628,25 @@ }, "enterprise": { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" } }, - "runner_group_id": { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", + "org_id": { + "name": "org_id", + "description": "Unique identifier of an organization.", "in": "path", "required": true, "schema": { "type": "integer" } }, - "org_id": { - "name": "org_id", - "description": "Unique identifier of an organization.", + "runner_group_id": { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index ff7d9e3f31..59504fc2bc 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -1699,6 +1699,267 @@ paths: previews: [] category: emojis subcategory: + "/enterprises/{enterprise}/actions/permissions": + get: + summary: Get GitHub Actions permissions for an enterprise + description: |- + Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-enterprise-permissions" + examples: + default: + "$ref": "#/components/examples/actions-enterprise-permissions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + put: + summary: Set GitHub Actions permissions for an enterprise + description: |- + Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + required: + - enabled_organizations + example: + enabled_organizations: all + allowed_actions: selected + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/permissions/organizations": + get: + summary: List selected organizations enabled for GitHub Actions in an enterprise + description: |- + Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-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 + 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 selected organizations enabled for GitHub Actions in an enterprise + description: |- + Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + example: + selected_organization_ids: + - 32 + - 91 + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": + put: + summary: Enable a selected organization for GitHub Actions in an enterprise + description: |- + Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/enable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/org_id" + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + delete: + summary: Disable a selected organization for GitHub Actions in an enterprise + description: |- + Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/disable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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/permissions/selected-actions": + get: + summary: Get allowed actions for an enterprise + description: |- + Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + put: + summary: Set allowed actions for an enterprise + description: |- + Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions "/enterprises/{enterprise}/actions/runner-groups": get: summary: List self-hosted runner groups for an enterprise @@ -4692,6 +4953,273 @@ paths: ``` category: orgs subcategory: + "/orgs/{org}/actions/permissions": + get: + summary: Get GitHub Actions permissions for an organization + description: |- + Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/get-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-organization-permissions" + examples: + default: + "$ref": "#/components/examples/actions-organization-permissions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set GitHub Actions permissions for an organization + description: |- + Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + + If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/set-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + enabled_repositories: + "$ref": "#/components/schemas/enabled-repositories" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + required: + - enabled_repositories + example: + enabled_repositories: all + allowed_actions: selected + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/repositories": + get: + summary: List selected repositories enabled for GitHub Actions in an organization + description: |- + Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/list-selected-repositories-enabled-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-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 + 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: permissions + put: + summary: Set selected repositories enabled for GitHub Actions in an organization + description: |- + Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/set-selected-repositories-enabled-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + example: + selected_repository_ids: + - 32 + - 42 + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/repositories/{repository_id}": + put: + summary: Enable a selected repository for GitHub Actions in an organization + description: |- + Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/enable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository_id" + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + delete: + summary: Disable a selected repository for GitHub Actions in an organization + description: |- + Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/disable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository_id" + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for an organization + description: |- + Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/get-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#get-allowed-actions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set allowed actions for an organization + description: |- + Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/set-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-allowed-actions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions "/orgs/{org}/actions/runner-groups": get: summary: List self-hosted runner groups for an organization @@ -11611,6 +12139,148 @@ paths: previews: [] category: actions subcategory: workflow-jobs + "/repos/{owner}/{repo}/actions/permissions": + get: + summary: Get GitHub Actions permissions for a repository + description: |- + Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + + You must authenticate using an access token with the `repo` scope to use this + endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/get-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-repository-permissions" + examples: + default: + "$ref": "#/components/examples/actions-repository-permissions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set GitHub Actions permissions for a repository + description: |- + Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + + If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/set-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + enabled: + "$ref": "#/components/schemas/actions-enabled" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + required: + - enabled + example: + enabled: true + allowed_actions: selected + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for a repository + description: |- + Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#get-allowed-actions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set allowed actions for a repository + description: |- + Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/set-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-allowed-actions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/runners": get: summary: List self-hosted runners for a repository @@ -34896,21 +35566,40 @@ components: - id - title - body - runner-groups-enterprise: + enabled-organizations: + type: string + description: 'The policy that controls the organizations in the enterprise that + are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' + enum: + - all + - none + - selected + allowed-actions: + type: string + description: 'The permissions policy that controls the actions that are allowed + to run. Can be one of: `all`, `local_only`, or `selected`.' + enum: + - all + - local_only + - selected + selected-actions-url: + type: string + description: The API URL to use to get or set the actions that are allowed to + run, when `allowed_actions` is set to `selected`. + actions-enterprise-permissions: type: object properties: - id: - type: number - name: - type: string - visibility: - type: string - default: - type: boolean + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" selected_organizations_url: type: string - runners_url: - type: string + description: The API URL to use to get or set the selected organizations + that are allowed to run GitHub Actions, when `enabled_organizations` is + set to `selected`. + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" organization-simple: title: Organization Simple description: Organization Simple @@ -34969,6 +35658,40 @@ components: - public_members_url - avatar_url - description + selected-actions: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, this + includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions in GitHub Marketplace from verified creators + are allowed. Set to `true` to allow all GitHub Marketplace actions by + verified creators. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow specific + action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, + `monalisa/octocat@v2`, `monalisa/*`." + items: + type: string + 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 runner: title: Self hosted runners description: A self hosted runner @@ -37109,6 +37832,28 @@ components: - type - created_at - updated_at + enabled-repositories: + type: string + description: 'The policy that controls the repositories in the organization + that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' + enum: + - all + - none + - selected + actions-organization-permissions: + type: object + properties: + enabled_repositories: + "$ref": "#/components/schemas/enabled-repositories" + selected_repositories_url: + type: string + description: The API URL to use to get or set the selected repositories + that are allowed to run GitHub Actions, when `enabled_repositories` is + set to `selected`. + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" runner-groups-org: type: object properties: @@ -39398,6 +40143,18 @@ components: - started_at - completed_at - check_run_url + actions-enabled: + type: boolean + description: Whether GitHub Actions is enabled on the repository. + actions-repository-permissions: + type: object + properties: + enabled: + "$ref": "#/components/schemas/actions-enabled" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" pull-request-minimal: title: Pull Request Minimal type: object @@ -47915,6 +48672,34 @@ components: The error was found in core/models.py in get_or_create_user at line 62. self.save() + actions-enterprise-permissions: + value: + enabled_organizations: all + allowed_actions: selected + selected_actions_url: https://api.github.com/enterprises/2/actions/permissions/selected-actions + 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 + selected-actions: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* runner-groups-enterprise: value: total_count: 3 @@ -47951,22 +48736,6 @@ components: 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 @@ -49258,47 +50027,11 @@ components: members_can_create_internal_repositories: false members_can_create_pages: true updated_at: '2014-03-03T18:58:10Z' - runner-groups-org: - value: - total_count: 3 - runner_groups: - - 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: 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-group: + actions-organization-permissions: value: - 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-group-item: - value: - 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 + enabled_repositories: all + allowed_actions: selected + selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions repository-paginated: value: total_count: 1 @@ -49419,6 +50152,47 @@ components: forks: 1 open_issues: 1 watchers: 1 + runner-groups-org: + value: + total_count: 3 + runner_groups: + - 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: 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-group: + value: + 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-group-item: + value: + 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 organization-actions-secret-paginated: value: total_count: 3 @@ -52449,6 +53223,11 @@ components: started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + actions-repository-permissions: + value: + enabled: true + allowed_actions: selected + selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions workflow-run-paginated: value: total_count: 1 @@ -62633,21 +63412,22 @@ components: type: integer enterprise: name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: type: string - runner_group_id: - name: runner_group_id - description: Unique identifier of the self-hosted runner group. + org_id: + name: org_id + description: Unique identifier of an organization. in: path required: true schema: type: integer - org_id: - name: org_id - description: Unique identifier of an organization. + runner_group_id: + name: runner_group_id + description: Unique identifier of the self-hosted runner group. in: path required: true schema: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index d221c031b9..6acc739b1b 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -12132,6 +12132,639 @@ } } }, + "/enterprises/{enterprise}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "selected_organizations_url": { + "type": "string", + "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + } + }, + "examples": { + "default": { + "value": { + "enabled_organizations": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled_organizations" + ] + }, + "example": { + "enabled_organizations": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations": { + "get": { + "summary": "List selected organizations enabled for GitHub Actions in an enterprise", + "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "organizations": { + "type": "array", + "items": { + "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" + ] + } + } + } + }, + "examples": { + "default": { + "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" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set selected organizations enabled for GitHub Actions in an enterprise", + "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "List of organization IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + } + }, + "required": [ + "selected_organization_ids" + ] + }, + "example": { + "selected_organization_ids": [ + 32, + 91 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + "put": { + "summary": "Enable a selected organization for GitHub Actions in an enterprise", + "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Disable a selected organization for GitHub Actions in an enterprise", + "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an enterprise", + "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set allowed actions for an enterprise", + "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, "/enterprises/{enterprise}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an enterprise", @@ -12147,7 +12780,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12271,7 +12904,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12403,7 +13036,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12488,7 +13121,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12601,7 +13234,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12649,7 +13282,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12824,7 +13457,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12900,7 +13533,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -12955,7 +13588,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -13012,7 +13645,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -13223,7 +13856,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -13299,7 +13932,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -13354,7 +13987,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -13411,7 +14044,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -13615,7 +14248,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -13716,7 +14349,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -14778,7 +15411,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -15840,7 +16473,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -15985,7 +16618,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -16033,7 +16666,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -16124,7 +16757,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -16193,7 +16826,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -40254,6 +40887,1629 @@ } } }, + "/orgs/{org}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + } + }, + "examples": { + "default": { + "value": { + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled_repositories" + ] + }, + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "template_repository": { + "type": "string" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "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 + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "example": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/enable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an organization", + "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-allowed-actions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions for an organization", + "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-allowed-actions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an organization", @@ -92261,6 +94517,326 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + } + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled" + ] + }, + "example": { + "enabled": true, + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for a repository", + "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#get-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions for a repository", + "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/rest/reference/actions#set-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", @@ -231618,7 +234194,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -231816,7 +234392,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -231999,7 +234575,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -232134,7 +234710,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -232324,7 +234900,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -232499,7 +235075,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -232547,7 +235123,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -232782,7 +235358,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -233044,7 +235620,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -233208,7 +235784,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -233477,7 +236053,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -233696,7 +236272,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 556f53f2ee..b9753c7356 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -9414,6 +9414,493 @@ paths: previews: [] category: emojis subcategory: + "/enterprises/{enterprise}/actions/permissions": + get: + summary: Get GitHub Actions permissions for an enterprise + description: |- + Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + enabled_organizations: + type: string + description: 'The policy that controls the organizations in the + enterprise that are allowed to run GitHub Actions. Can be one + of: `all`, `none`, or `selected`.' + enum: + - all + - none + - selected + selected_organizations_url: + type: string + description: The API URL to use to get or set the selected organizations + that are allowed to run GitHub Actions, when `enabled_organizations` + is set to `selected`. + allowed_actions: + type: string + description: 'The permissions policy that controls the actions + that are allowed to run. Can be one of: `all`, `local_only`, + or `selected`.' + enum: + - all + - local_only + - selected + selected_actions_url: + type: string + description: The API URL to use to get or set the actions that + are allowed to run, when `allowed_actions` is set to `selected`. + examples: + default: + value: + enabled_organizations: all + allowed_actions: selected + selected_actions_url: https://api.github.com/enterprises/2/actions/permissions/selected-actions + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + put: + summary: Set GitHub Actions permissions for an enterprise + description: |- + Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + enabled_organizations: + type: string + description: 'The policy that controls the organizations in the + enterprise that are allowed to run GitHub Actions. Can be one + of: `all`, `none`, or `selected`.' + enum: + - all + - none + - selected + allowed_actions: + type: string + description: 'The permissions policy that controls the actions that + are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' + enum: + - all + - local_only + - selected + required: + - enabled_organizations + example: + enabled_organizations: all + allowed_actions: selected + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/permissions/organizations": + get: + summary: List selected organizations enabled for GitHub Actions in an enterprise + description: |- + Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + organizations: + type: array + items: + 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 + examples: + default: + 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 + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + put: + summary: Set selected organizations enabled for GitHub Actions in an enterprise + description: |- + Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + example: + selected_organization_ids: + - 32 + - 91 + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": + put: + summary: Enable a selected organization for GitHub Actions in an enterprise + description: |- + Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/enable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + - name: org_id + description: Unique identifier of an organization. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + delete: + summary: Disable a selected organization for GitHub Actions in an enterprise + description: |- + Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/disable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + - name: org_id + description: Unique identifier of an organization. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for an enterprise + description: |- + Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, + this includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions in GitHub Marketplace from verified + creators are allowed. Set to `true` to allow all GitHub Marketplace + actions by verified creators. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow + specific action(s). Wildcards, tags, and SHAs are allowed. For + example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." + items: + type: string + examples: + default: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + put: + summary: Set allowed actions for an enterprise + description: |- + Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, + this includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions in GitHub Marketplace from verified + creators are allowed. Set to `true` to allow all GitHub Marketplace + actions by verified creators. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow + specific action(s). Wildcards, tags, and SHAs are allowed. For + example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." + items: + type: string + examples: + selected_actions: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions "/enterprises/{enterprise}/actions/runner-groups": get: summary: List self-hosted runner groups for an enterprise @@ -9429,7 +9916,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runner-groups-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -9514,7 +10002,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#create-self-hosted-runner-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -9609,7 +10098,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#get-a-self-hosted-runner-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -9669,7 +10159,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#update-a-self-hosted-runner-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -9749,7 +10240,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -9784,7 +10276,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -9914,7 +10407,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -9968,7 +10462,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10008,7 +10503,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10049,7 +10545,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10196,7 +10693,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10250,7 +10748,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10290,7 +10789,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10331,7 +10831,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runners-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10473,7 +10974,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#list-runner-applications-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -10550,7 +11052,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#create-a-registration-token-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -11360,7 +11863,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#create-a-remove-token-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -12161,7 +12665,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#get-a-self-hosted-runner-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -12266,7 +12771,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/actions/#delete-self-hosted-runner-from-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -12303,7 +12809,8 @@ paths: url: https://developer.github.com/v3/billing/#get-github-actions-billing-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -12371,7 +12878,8 @@ paths: url: https://developer.github.com/v3/billing/#get-github-packages-billing-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -12423,7 +12931,8 @@ paths: url: https://developer.github.com/v3/billing/#get-shared-storage-billing-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -30614,39 +31123,25 @@ paths: ``` category: orgs subcategory: - "/orgs/{org}/actions/runner-groups": + "/orgs/{org}/actions/permissions": get: - summary: List self-hosted runner groups for an organization + summary: Get GitHub Actions permissions 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)." + Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - operationId: actions/list-self-hosted-runner-groups-for-org + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/get-github-actions-permissions-organization 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 + url: https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization parameters: - name: org in: path required: true schema: type: string - - name: per_page - description: Results per page (max 100) - in: query - schema: - type: integer - default: 30 - - name: page - description: Page number of the results to fetch. - in: query - schema: - type: integer - default: 1 responses: '200': description: response @@ -30655,367 +31150,1631 @@ paths: schema: type: object properties: - total_count: - type: number - runner_groups: - type: array - items: - type: object - properties: - id: - type: number - name: - type: string - visibility: - type: string - default: - type: boolean - selected_repositories_url: - type: string - runners_url: - type: string - inherited: - type: boolean - examples: - default: - value: - total_count: 3 - runner_groups: - - 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: 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 - 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)." - - Creates a new self-hosted runner group for an organization. - - You 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: - - name: org - in: path - required: true - schema: - type: string - 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: - type: object - properties: - id: - type: number - name: - type: string - visibility: + enabled_repositories: type: string - default: - type: boolean + description: 'The policy that controls the repositories in the + organization that are allowed to run GitHub Actions. Can be + one of: `all`, `none`, or `selected`.' + enum: + - all + - none + - selected selected_repositories_url: type: string - runners_url: + description: The API URL to use to get or set the selected repositories + that are allowed to run GitHub Actions, when `enabled_repositories` + is set to `selected`. + allowed_actions: type: string - inherited: - type: boolean - examples: - default: - value: - 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 - 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)." - - Gets a specific self-hosted runner group for an organization. - - You 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: - - name: org - in: path - required: true - schema: - type: string - - name: runner_group_id - description: Unique identifier of the self-hosted runner group. - in: path - required: true - schema: - type: integer - responses: - '200': - description: response - content: - application/json: - schema: - type: object - properties: - id: - type: number - name: - type: string - visibility: - type: string - default: - type: boolean - selected_repositories_url: - type: string - runners_url: + description: 'The permissions policy that controls the actions + that are allowed to run. Can be one of: `all`, `local_only`, + or `selected`.' + enum: + - all + - local_only + - selected + selected_actions_url: type: string - inherited: - type: boolean + description: The API URL to use to get or set the actions that + are allowed to run, when `allowed_actions` is set to `selected`. examples: default: value: - 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 + enabled_repositories: all + allowed_actions: selected + selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions 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 + subcategory: permissions + put: + summary: Set GitHub Actions permissions 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)." + Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - Updates the `name` and `visibility` of a self-hosted runner group in an organization. + If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - operationId: actions/update-self-hosted-runner-group-for-org + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/set-github-actions-permissions-organization 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 + url: https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization parameters: - name: org in: path required: true schema: type: string - - name: runner_group_id - description: Unique identifier of the self-hosted runner group. - in: path - required: true - schema: - type: integer + responses: + '204': + description: Empty response 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`.' + enabled_repositories: type: string + description: 'The policy that controls the repositories in the organization + that are allowed to run GitHub Actions. Can be one of: `all`, + `none`, or `selected`.' enum: + - all + - none - selected + allowed_actions: + type: string + description: 'The permissions policy that controls the actions that + are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' + enum: - all - - private + - local_only + - selected + required: + - enabled_repositories example: - name: Expensive hardware runners - visibility: selected - responses: - '200': - description: response - content: - application/json: - schema: - type: object - properties: - id: - type: number - name: - type: string - visibility: - type: string - default: - type: boolean - selected_repositories_url: - type: string - runners_url: - type: string - inherited: - type: boolean - examples: - default: - value: - 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 + enabled_repositories: all + allowed_actions: selected 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 + subcategory: permissions + "/orgs/{org}/actions/permissions/repositories": + get: + summary: List selected repositories enabled for GitHub Actions 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)." + Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - Deletes a self-hosted runner group for an organization. - - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - operationId: actions/delete-self-hosted-runner-group-from-org + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/list-selected-repositories-enabled-github-actions-organization 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 + url: https://developer.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - name: org in: path required: true schema: type: string - - name: runner_group_id - description: Unique identifier of the self-hosted runner group. - in: path - required: true + - name: per_page + description: Results per page (max 100) + in: query schema: type: integer - 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)." - - Lists the repositories with access to a self-hosted runner group configured in an organization. - - You 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: - - name: org - in: path - required: true - schema: - type: string - - name: runner_group_id - description: Unique identifier of the self-hosted runner group. - in: path - required: true + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + repositories: + type: array + items: + title: Repository + description: A git repository + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + nullable: true + allOf: + - title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + nullable: true + allOf: + - title: Simple User + description: Simple User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: '' + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template + that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, + or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + template_repository: + type: object + nullable: true + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + private: + type: boolean + html_url: + type: string + description: + type: string + fork: + type: boolean + url: + type: string + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + downloads_url: + type: string + events_url: + type: string + forks_url: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + pulls_url: + type: string + releases_url: + type: string + ssh_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + clone_url: + type: string + mirror_url: + type: string + hooks_url: + type: string + svn_url: + type: string + homepage: + type: string + language: + type: string + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + admin: + type: boolean + push: + type: boolean + pull: + type: boolean + allow_rebase_merge: + type: boolean + template_repository: + type: string + temp_clone_token: + type: string + allow_squash_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_merge_commit: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + examples: + default: + 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: + 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: + 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 + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set selected repositories enabled for GitHub Actions in an organization + description: |- + Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/set-selected-repositories-enabled-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + example: + selected_repository_ids: + - 32 + - 42 + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/repositories/{repository_id}": + put: + summary: Enable a selected repository for GitHub Actions in an organization + description: |- + Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/enable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + delete: + summary: Disable a selected repository for GitHub Actions in an organization + description: |- + Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/disable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for an organization + description: |- + Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/get-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#get-allowed-actions-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, + this includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions in GitHub Marketplace from verified + creators are allowed. Set to `true` to allow all GitHub Marketplace + actions by verified creators. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow + specific action(s). Wildcards, tags, and SHAs are allowed. For + example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." + items: + type: string + examples: + default: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set allowed actions for an organization + description: |- + Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + operationId: actions/set-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-allowed-actions-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, + this includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions in GitHub Marketplace from verified + creators are allowed. Set to `true` to allow all GitHub Marketplace + actions by verified creators. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow + specific action(s). Wildcards, tags, and SHAs are allowed. For + example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." + items: + type: string + examples: + selected_actions: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/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)." + + Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + + You 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: + - name: org + in: path + required: true + schema: + type: string + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runner_groups: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + total_count: 3 + runner_groups: + - 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: 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 + 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)." + + Creates a new self-hosted runner group for an organization. + + You 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: + - name: org + in: path + required: true + schema: + type: string + 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: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + 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 + 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)." + + Gets a specific self-hosted runner group for an organization. + + You 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: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + 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 + 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)." + + Updates the `name` and `visibility` of a self-hosted runner group in an organization. + + You 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: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + 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: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + 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 + 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)." + + Deletes a self-hosted runner group for an organization. + + You 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: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + 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)." + + Lists the repositories with access to a self-hosted runner group configured in an organization. + + You 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: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true schema: type: integer responses: @@ -70759,6 +72518,251 @@ paths: previews: [] category: actions subcategory: workflow-jobs + "/repos/{owner}/{repo}/actions/permissions": + get: + summary: Get GitHub Actions permissions for a repository + description: |- + Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + + You must authenticate using an access token with the `repo` scope to use this + endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/get-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether GitHub Actions is enabled on the repository. + allowed_actions: + type: string + description: 'The permissions policy that controls the actions + that are allowed to run. Can be one of: `all`, `local_only`, + or `selected`.' + enum: + - all + - local_only + - selected + selected_actions_url: + type: string + description: The API URL to use to get or set the actions that + are allowed to run, when `allowed_actions` is set to `selected`. + examples: + default: + value: + enabled: true + allowed_actions: selected + selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set GitHub Actions permissions for a repository + description: |- + Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + + If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/set-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether GitHub Actions is enabled on the repository. + allowed_actions: + type: string + description: 'The permissions policy that controls the actions that + are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' + enum: + - all + - local_only + - selected + required: + - enabled + example: + enabled: true + allowed_actions: selected + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for a repository + description: |- + Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#get-allowed-actions-for-a-repository + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, + this includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions in GitHub Marketplace from verified + creators are allowed. Set to `true` to allow all GitHub Marketplace + actions by verified creators. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow + specific action(s). Wildcards, tags, and SHAs are allowed. For + example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." + items: + type: string + examples: + default: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions + put: + summary: Set allowed actions for a repository + description: |- + Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + operationId: actions/set-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/rest/reference/actions#set-allowed-actions-for-a-repository + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + requestBody: + content: + application/json: + schema: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, + this includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions in GitHub Marketplace from verified + creators are allowed. Set to `true` to allow all GitHub Marketplace + actions by verified creators. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow + specific action(s). Wildcards, tags, and SHAs are allowed. For + example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." + items: + type: string + examples: + selected_actions: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/runners": get: summary: List self-hosted runners for a repository @@ -178190,7 +180194,8 @@ paths: groups-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -178323,7 +180328,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#provision-a-scim-enterprise-group-and-invite-users parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -178444,7 +180450,8 @@ paths: group parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -178536,7 +180543,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#set-scim-information-for-a-provisioned-enterprise-group parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -178663,7 +180671,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#update-an-attribute-for-a-scim-enterprise-group parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -178777,7 +180786,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#delete-a-scim-group-from-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -178827,7 +180837,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#list-scim-provisioned-identities-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -178985,7 +180996,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#provision-and-invite-a-scim-enterprise-user parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -179159,7 +181171,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#get-scim-provisioning-information-for-an-enterprise-user parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -179273,7 +181286,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#set-scim-information-for-a-provisioned-enterprise-user parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -179469,7 +181483,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#update-an-attribute-for-a-scim-enterprise-user parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -179610,7 +181625,8 @@ paths: url: https://developer.github.com/v3/enterprise-admin/scim/#delete-a-scim-user-from-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json index 135ca68865..da5eeee586 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml index 0c76764b09..8467c461d1 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.18/ghes-2.18.json b/descriptions/ghes-2.18/ghes-2.18.json index 6ce91dc082..e3f9ff8973 100644 --- a/descriptions/ghes-2.18/ghes-2.18.json +++ b/descriptions/ghes-2.18/ghes-2.18.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.18/ghes-2.18.yaml b/descriptions/ghes-2.18/ghes-2.18.yaml index 142ceea47c..6972d848bc 100644 --- a/descriptions/ghes-2.18/ghes-2.18.yaml +++ b/descriptions/ghes-2.18/ghes-2.18.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json index f1e0e68f2d..8dbca6f9fd 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml index 3599992ad5..b8b7552c30 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.19/ghes-2.19.json b/descriptions/ghes-2.19/ghes-2.19.json index aa87350a01..77154417f6 100644 --- a/descriptions/ghes-2.19/ghes-2.19.json +++ b/descriptions/ghes-2.19/ghes-2.19.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.19/ghes-2.19.yaml b/descriptions/ghes-2.19/ghes-2.19.yaml index bcccaf1bb9..1c59d4263a 100644 --- a/descriptions/ghes-2.19/ghes-2.19.yaml +++ b/descriptions/ghes-2.19/ghes-2.19.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json index f39cf4a02f..6a74761c4c 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml index c08e3bca8e..be6b5e4000 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.20/ghes-2.20.json b/descriptions/ghes-2.20/ghes-2.20.json index 83fa06e553..d4331a04b2 100644 --- a/descriptions/ghes-2.20/ghes-2.20.json +++ b/descriptions/ghes-2.20/ghes-2.20.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.20/ghes-2.20.yaml b/descriptions/ghes-2.20/ghes-2.20.yaml index ba80076a8e..00be6d7166 100644 --- a/descriptions/ghes-2.20/ghes-2.20.yaml +++ b/descriptions/ghes-2.20/ghes-2.20.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json index 261f348902..48e70f3fae 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml index 069a5034ad..32d8e9986c 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.21/ghes-2.21.json b/descriptions/ghes-2.21/ghes-2.21.json index 65ddedf586..03feba4c65 100644 --- a/descriptions/ghes-2.21/ghes-2.21.json +++ b/descriptions/ghes-2.21/ghes-2.21.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.21/ghes-2.21.yaml b/descriptions/ghes-2.21/ghes-2.21.yaml index 02328d3ab3..a016027663 100644 --- a/descriptions/ghes-2.21/ghes-2.21.yaml +++ b/descriptions/ghes-2.21/ghes-2.21.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json index ec02964eed..55f72b34f0 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -16864,7 +16864,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -16988,7 +16988,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17120,7 +17120,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17205,7 +17205,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17318,7 +17318,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17366,7 +17366,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17541,7 +17541,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17617,7 +17617,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17672,7 +17672,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17729,7 +17729,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17859,7 +17859,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17935,7 +17935,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -17990,7 +17990,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -18047,7 +18047,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -18170,7 +18170,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -18271,7 +18271,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -19333,7 +19333,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -20395,7 +20395,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { @@ -20476,7 +20476,7 @@ "parameters": [ { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml index 05a6beaaaf..5ac3330ce1 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -12928,7 +12928,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#list-self-hosted-runner-groups-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13013,7 +13014,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#create-self-hosted-runner-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13108,7 +13110,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#get-a-self-hosted-runner-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13168,7 +13171,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#update-a-self-hosted-runner-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13248,7 +13252,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13283,7 +13288,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13413,7 +13419,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13467,7 +13474,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13507,7 +13515,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13548,7 +13557,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13637,7 +13647,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13691,7 +13702,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13731,7 +13743,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13772,7 +13785,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#list-self-hosted-runners-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13856,7 +13870,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#list-runner-applications-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -13933,7 +13948,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#create-a-registration-token-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -14743,7 +14759,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#create-a-remove-token-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -15544,7 +15561,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#get-a-self-hosted-runner-for-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: @@ -15601,7 +15619,8 @@ paths: url: https://developer.github.com/enterprise/2.22/v3/enterprise-admin/actions/#delete-self-hosted-runner-from-an-enterprise parameters: - name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: diff --git a/descriptions/ghes-2.22/ghes-2.22.json b/descriptions/ghes-2.22/ghes-2.22.json index 4c0ea76d5a..267a57bc8e 100644 --- a/descriptions/ghes-2.22/ghes-2.22.json +++ b/descriptions/ghes-2.22/ghes-2.22.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.1", + "version": "1.1.0", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -43964,7 +43964,7 @@ }, "enterprise": { "name": "enterprise", - "description": "Unique identifier of the GitHub Enterprise Cloud instance.", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { diff --git a/descriptions/ghes-2.22/ghes-2.22.yaml b/descriptions/ghes-2.22/ghes-2.22.yaml index e4063c6ee5..b7cf11e89c 100644 --- a/descriptions/ghes-2.22/ghes-2.22.yaml +++ b/descriptions/ghes-2.22/ghes-2.22.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.1 + version: 1.1.0 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -31763,7 +31763,8 @@ components: type: integer enterprise: name: enterprise - description: Unique identifier of the GitHub Enterprise Cloud instance. + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. in: path required: true schema: