diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 7c1940e3f9..3fcbbff390 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -6376,653 +6376,6 @@ } } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { - "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "days": 90, - "maximum_allowed_days": 365 - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - }, - "examples": { - "application/json": { - "value": { - "days": 100 - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "summary": "Set approval policy to first time contributors", - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { - "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" - }, - "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { - "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/self-hosted-runners-settings" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", - "enum": [ - "all", - "selected", - "none" - ] - } - } - }, - "examples": { - "application/json": { - "value": { - "enabled_repositories": "all" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { - "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/repository-paginated" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "selected_repository_ids" - ], - "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" - } - } - }, - "examples": { - "application/json": { - "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -8568,6 +7921,313 @@ } } }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/repositories": { "get": { "summary": "List selected repositories enabled for GitHub Actions in an organization", @@ -8841,6 +8501,346 @@ } } }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/self-hosted-runners-settings" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] + } + } + }, + "examples": { + "application/json": { + "value": { + "enabled_repositories": "all" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + "get": { + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "selected_repository_ids" + ], + "properties": { + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" + } + } + }, + "examples": { + "application/json": { + "value": { + "selected_repository_ids": [ + 1, + 2, + 3 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + "put": { + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", @@ -13150,9 +13150,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -15370,6 +15370,9 @@ { "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" + }, { "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" }, @@ -107138,124 +107141,6 @@ "description" ] }, - "actions-artifact-and-log-retention-response": { - "type": "object", - "properties": { - "days": { - "type": "integer", - "description": "The number of days artifacts and logs are retained" - }, - "maximum_allowed_days": { - "type": "integer", - "description": "The maximum number of days that can be configured" - } - }, - "required": [ - "days", - "maximum_allowed_days" - ] - }, - "actions-artifact-and-log-retention": { - "type": "object", - "properties": { - "days": { - "type": "integer", - "description": "The number of days to retain artifacts and logs" - } - }, - "required": [ - "days" - ] - }, - "actions-fork-pr-contributor-approval": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] - }, - "actions-fork-pr-workflows-private-repos": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests", - "send_write_tokens_to_workflows", - "send_secrets_and_variables", - "require_approval_for_fork_pr_workflows" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "actions-fork-pr-workflows-private-repos-request": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "self-hosted-runners-settings": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" - } - } - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -108288,6 +108173,103 @@ "enabled_repositories" ] }, + "actions-artifact-and-log-retention-response": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" + ] + }, + "actions-artifact-and-log-retention": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" + } + }, + "required": [ + "days" + ] + }, + "actions-fork-pr-contributor-approval": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "actions-fork-pr-workflows-private-repos": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, + "actions-fork-pr-workflows-private-repos-request": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, "selected-actions": { "type": "object", "properties": { @@ -108308,6 +108290,27 @@ } } }, + "self-hosted-runners-settings": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + } + } + }, "actions-default-workflow-permissions": { "type": "string", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", @@ -143980,6 +143983,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -143991,6 +143997,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -285865,149 +285874,6 @@ } ] }, - "actions-fork-pr-contributor-approval": { - "value": { - "approval_policy": "first_time_contributors" - } - }, - "actions-fork-pr-workflows-private-repos": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - }, - "repository-paginated": { - "value": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - } - ] - } - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -286328,6 +286194,149 @@ "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } }, + "actions-fork-pr-contributor-approval": { + "value": { + "approval_policy": "first_time_contributors" + } + }, + "actions-fork-pr-workflows-private-repos": { + "value": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + } + }, + "repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "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 + } + ] + } + }, "selected-actions": { "value": { "github_owned_allowed": true, @@ -312386,7 +312395,7 @@ }, "enterprise": { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -312731,15 +312740,6 @@ "type": "string" } }, - "repository-id": { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "billing-usage-report-year": { "name": "year", "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", @@ -312785,6 +312785,15 @@ "type": "integer" } }, + "repository-id": { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "visible-to-repository": { "name": "visible_to_repository", "description": "Only return runner groups that are allowed to be used by this repository.", @@ -312875,6 +312884,14 @@ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" } }, + "dependabot-alert-comma-separated-artifact-registry-urls": { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, "hook-id": { "name": "hook_id", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index e7ffcc66b6..a0482e9ce5 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -4502,458 +4502,6 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: - "$ref": "#/components/schemas/basic-error" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/self-hosted-runners-settings" - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer - repositories: - type: array - items: - "$ref": "#/components/schemas/repository" - examples: - default: - "$ref": "#/components/examples/repository-paginated" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -6154,6 +5702,218 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -6348,6 +6108,246 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/self-hosted-runners-settings" + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/repository" + examples: + default: + "$ref": "#/components/examples/repository-paginated" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -9545,9 +9545,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -11244,6 +11244,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" @@ -77618,101 +77619,6 @@ components: - public_members_url - avatar_url - description - actions-artifact-and-log-retention-response: - type: object - properties: - days: - type: integer - description: The number of days artifacts and logs are retained - maximum_allowed_days: - type: integer - description: The maximum number of days that can be configured - required: - - days - - maximum_allowed_days - actions-artifact-and-log-retention: - type: object - properties: - days: - type: integer - description: The number of days to retain artifacts and logs - required: - - days - actions-fork-pr-contributor-approval: - type: object - properties: - approval_policy: - type: string - enum: - - first_time_contributors_new_to_github - - first_time_contributors - - all_external_contributors - description: The policy that controls when fork PR workflows require approval - from a maintainer. - required: - - approval_policy - actions-fork-pr-workflows-private-repos: - type: object - required: - - run_workflows_from_fork_pull_requests - - send_write_tokens_to_workflows - - send_secrets_and_variables - - require_approval_for_fork_pr_workflows - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from forks are - allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or submit approving - pull request reviews from a workflow triggered by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to workflows - triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from forks require - approval from a repository administrator to run. - actions-fork-pr-workflows-private-repos-request: - type: object - required: - - run_workflows_from_fork_pull_requests - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from forks are - allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or submit approving - pull request reviews from a workflow triggered by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to workflows - triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from forks require - approval from a repository administrator to run. - self-hosted-runners-settings: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners can be - used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -78501,6 +78407,84 @@ components: "$ref": "#/components/schemas/selected-actions-url" required: - enabled_repositories + actions-artifact-and-log-retention-response: + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + actions-artifact-and-log-retention: + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + actions-fork-pr-contributor-approval: + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require approval + from a maintainer. + required: + - approval_policy + actions-fork-pr-workflows-private-repos: + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. + actions-fork-pr-workflows-private-repos-request: + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. selected-actions: type: object properties: @@ -78522,6 +78506,23 @@ components: > The `patterns_allowed` setting only applies to public repositories. items: type: string + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be + used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization actions-default-workflow-permissions: type: string description: The default workflow permissions granted to the GITHUB_TOKEN when @@ -104468,6 +104469,8 @@ components: type: string title: type: string + title_html: + type: string duration: type: - number @@ -104476,6 +104479,8 @@ components: type: - string - 'null' + completed: + type: boolean required: - id - title @@ -210993,136 +210998,6 @@ components: public_members_url: https://api.github.com/orgs/github/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization - actions-fork-pr-contributor-approval: - value: - approval_policy: first_time_contributors - actions-fork-pr-workflows-private-repos: - value: - run_workflows_from_fork_pull_requests: true - send_write_tokens_to_workflows: false - send_secrets_and_variables: false - require_approval_for_fork_pr_workflows: true - repository-paginated: - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - 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 - allow_auto_merge: false - 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 dependabot-repository-access-details: value: default_level: public @@ -211387,6 +211262,136 @@ components: enabled_repositories: all allowed_actions: selected selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions + actions-fork-pr-contributor-approval: + value: + approval_policy: first_time_contributors + actions-fork-pr-workflows-private-repos: + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + 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 + allow_auto_merge: false + 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 selected-actions: value: github_owned_allowed: true @@ -233771,8 +233776,7 @@ components: type: integer enterprise: name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -234085,13 +234089,6 @@ components: required: true schema: type: string - repository-id: - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -234135,6 +234132,13 @@ components: required: true schema: type: integer + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer visible-to-repository: name: visible_to_repository description: Only return runner groups that are allowed to be used by this repository. @@ -234211,6 +234215,14 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 7c1940e3f9..3fcbbff390 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -6376,653 +6376,6 @@ } } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { - "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "days": 90, - "maximum_allowed_days": 365 - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - }, - "examples": { - "application/json": { - "value": { - "days": 100 - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "summary": "Set approval policy to first time contributors", - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { - "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" - }, - "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { - "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/self-hosted-runners-settings" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", - "enum": [ - "all", - "selected", - "none" - ] - } - } - }, - "examples": { - "application/json": { - "value": { - "enabled_repositories": "all" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { - "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/repository-paginated" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "selected_repository_ids" - ], - "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" - } - } - }, - "examples": { - "application/json": { - "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -8568,6 +7921,313 @@ } } }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/repositories": { "get": { "summary": "List selected repositories enabled for GitHub Actions in an organization", @@ -8841,6 +8501,346 @@ } } }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/self-hosted-runners-settings" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] + } + } + }, + "examples": { + "application/json": { + "value": { + "enabled_repositories": "all" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + "get": { + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "selected_repository_ids" + ], + "properties": { + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" + } + } + }, + "examples": { + "application/json": { + "value": { + "selected_repository_ids": [ + 1, + 2, + 3 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + "put": { + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", @@ -13150,9 +13150,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -15370,6 +15370,9 @@ { "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" + }, { "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" }, @@ -107138,124 +107141,6 @@ "description" ] }, - "actions-artifact-and-log-retention-response": { - "type": "object", - "properties": { - "days": { - "type": "integer", - "description": "The number of days artifacts and logs are retained" - }, - "maximum_allowed_days": { - "type": "integer", - "description": "The maximum number of days that can be configured" - } - }, - "required": [ - "days", - "maximum_allowed_days" - ] - }, - "actions-artifact-and-log-retention": { - "type": "object", - "properties": { - "days": { - "type": "integer", - "description": "The number of days to retain artifacts and logs" - } - }, - "required": [ - "days" - ] - }, - "actions-fork-pr-contributor-approval": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] - }, - "actions-fork-pr-workflows-private-repos": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests", - "send_write_tokens_to_workflows", - "send_secrets_and_variables", - "require_approval_for_fork_pr_workflows" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "actions-fork-pr-workflows-private-repos-request": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "self-hosted-runners-settings": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" - } - } - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -108288,6 +108173,103 @@ "enabled_repositories" ] }, + "actions-artifact-and-log-retention-response": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" + ] + }, + "actions-artifact-and-log-retention": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" + } + }, + "required": [ + "days" + ] + }, + "actions-fork-pr-contributor-approval": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "actions-fork-pr-workflows-private-repos": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, + "actions-fork-pr-workflows-private-repos-request": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, "selected-actions": { "type": "object", "properties": { @@ -108308,6 +108290,27 @@ } } }, + "self-hosted-runners-settings": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + } + } + }, "actions-default-workflow-permissions": { "type": "string", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", @@ -143980,6 +143983,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -143991,6 +143997,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -285865,149 +285874,6 @@ } ] }, - "actions-fork-pr-contributor-approval": { - "value": { - "approval_policy": "first_time_contributors" - } - }, - "actions-fork-pr-workflows-private-repos": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - }, - "repository-paginated": { - "value": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - } - ] - } - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -286328,6 +286194,149 @@ "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } }, + "actions-fork-pr-contributor-approval": { + "value": { + "approval_policy": "first_time_contributors" + } + }, + "actions-fork-pr-workflows-private-repos": { + "value": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + } + }, + "repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "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 + } + ] + } + }, "selected-actions": { "value": { "github_owned_allowed": true, @@ -312386,7 +312395,7 @@ }, "enterprise": { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -312731,15 +312740,6 @@ "type": "string" } }, - "repository-id": { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "billing-usage-report-year": { "name": "year", "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", @@ -312785,6 +312785,15 @@ "type": "integer" } }, + "repository-id": { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "visible-to-repository": { "name": "visible_to_repository", "description": "Only return runner groups that are allowed to be used by this repository.", @@ -312875,6 +312884,14 @@ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" } }, + "dependabot-alert-comma-separated-artifact-registry-urls": { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, "hook-id": { "name": "hook_id", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index e7ffcc66b6..a0482e9ce5 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -4502,458 +4502,6 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: - "$ref": "#/components/schemas/basic-error" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/self-hosted-runners-settings" - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer - repositories: - type: array - items: - "$ref": "#/components/schemas/repository" - examples: - default: - "$ref": "#/components/examples/repository-paginated" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -6154,6 +5702,218 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -6348,6 +6108,246 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/self-hosted-runners-settings" + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/repository" + examples: + default: + "$ref": "#/components/examples/repository-paginated" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -9545,9 +9545,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -11244,6 +11244,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" @@ -77618,101 +77619,6 @@ components: - public_members_url - avatar_url - description - actions-artifact-and-log-retention-response: - type: object - properties: - days: - type: integer - description: The number of days artifacts and logs are retained - maximum_allowed_days: - type: integer - description: The maximum number of days that can be configured - required: - - days - - maximum_allowed_days - actions-artifact-and-log-retention: - type: object - properties: - days: - type: integer - description: The number of days to retain artifacts and logs - required: - - days - actions-fork-pr-contributor-approval: - type: object - properties: - approval_policy: - type: string - enum: - - first_time_contributors_new_to_github - - first_time_contributors - - all_external_contributors - description: The policy that controls when fork PR workflows require approval - from a maintainer. - required: - - approval_policy - actions-fork-pr-workflows-private-repos: - type: object - required: - - run_workflows_from_fork_pull_requests - - send_write_tokens_to_workflows - - send_secrets_and_variables - - require_approval_for_fork_pr_workflows - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from forks are - allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or submit approving - pull request reviews from a workflow triggered by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to workflows - triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from forks require - approval from a repository administrator to run. - actions-fork-pr-workflows-private-repos-request: - type: object - required: - - run_workflows_from_fork_pull_requests - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from forks are - allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or submit approving - pull request reviews from a workflow triggered by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to workflows - triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from forks require - approval from a repository administrator to run. - self-hosted-runners-settings: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners can be - used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -78501,6 +78407,84 @@ components: "$ref": "#/components/schemas/selected-actions-url" required: - enabled_repositories + actions-artifact-and-log-retention-response: + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + actions-artifact-and-log-retention: + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + actions-fork-pr-contributor-approval: + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require approval + from a maintainer. + required: + - approval_policy + actions-fork-pr-workflows-private-repos: + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. + actions-fork-pr-workflows-private-repos-request: + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. selected-actions: type: object properties: @@ -78522,6 +78506,23 @@ components: > The `patterns_allowed` setting only applies to public repositories. items: type: string + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be + used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization actions-default-workflow-permissions: type: string description: The default workflow permissions granted to the GITHUB_TOKEN when @@ -104468,6 +104469,8 @@ components: type: string title: type: string + title_html: + type: string duration: type: - number @@ -104476,6 +104479,8 @@ components: type: - string - 'null' + completed: + type: boolean required: - id - title @@ -210993,136 +210998,6 @@ components: public_members_url: https://api.github.com/orgs/github/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization - actions-fork-pr-contributor-approval: - value: - approval_policy: first_time_contributors - actions-fork-pr-workflows-private-repos: - value: - run_workflows_from_fork_pull_requests: true - send_write_tokens_to_workflows: false - send_secrets_and_variables: false - require_approval_for_fork_pr_workflows: true - repository-paginated: - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - 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 - allow_auto_merge: false - 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 dependabot-repository-access-details: value: default_level: public @@ -211387,6 +211262,136 @@ components: enabled_repositories: all allowed_actions: selected selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions + actions-fork-pr-contributor-approval: + value: + approval_policy: first_time_contributors + actions-fork-pr-workflows-private-repos: + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + 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 + allow_auto_merge: false + 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 selected-actions: value: github_owned_allowed: true @@ -233771,8 +233776,7 @@ components: type: integer enterprise: name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -234085,13 +234089,6 @@ components: required: true schema: type: string - repository-id: - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -234135,6 +234132,13 @@ components: required: true schema: type: integer + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer visible-to-repository: name: visible_to_repository description: Only return runner groups that are allowed to be used by this repository. @@ -234211,6 +234215,14 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 6b11f2e8df..c9210306f9 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -18194,7 +18194,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -18654,7 +18654,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19381,7 +19381,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19799,7 +19799,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20209,7 +20209,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20868,7 +20868,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21059,7 +21059,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21226,7 +21226,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21692,7 +21692,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22486,7 +22486,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24482,7 +24482,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58630,17 +58630,17 @@ } } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { + "/organizations/{org}/dependabot/repository-access": { "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -58651,6 +58651,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } } ], "responses": { @@ -58659,28 +58682,666 @@ "content": { "application/json": { "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days artifacts and logs are retained" + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] }, - "maximum_allowed_days": { - "type": "integer", - "description": "The maximum number of days that can be configured" + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ] + } } }, - "required": [ - "days", - "maximum_allowed_days" - ] + "additionalProperties": false }, "examples": { - "response": { - "summary": "Example response", + "default": { "value": { - "days": 90, - "maximum_allowed_days": 365 + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] } } } @@ -58741,21 +59402,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/update-repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -58775,19 +59437,50 @@ "schema": { "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days to retain artifacts and logs" + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." } }, - "required": [ - "days" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "application/json": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "days": 100 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] } } } @@ -58796,7 +59489,7 @@ }, "responses": { "204": { - "description": "No content" + "description": "Response" }, "403": { "description": "Forbidden", @@ -58849,127 +59542,27 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", + "/organizations/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -58982,40 +59575,46 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } }, - "examples": { - "default": { - "value": { - "approval_policy": "first_time_contributors" - } + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" } } } } + } + }, + "responses": { + "204": { + "description": "Response" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59039,39 +59638,6 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -59098,133 +59664,27 @@ } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] - }, - "examples": { - "default": { - "summary": "Set approval policy to first time contributors", - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { + "/organizations/{org}/settings/billing/usage": { "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", + "summary": "Get billing usage report for an organization", + "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).\"", "tags": [ - "actions" + "billing" ], + "operationId": "billing/get-github-billing-usage-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -59235,55 +59695,144 @@ "schema": { "type": "string" } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response", + "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests", - "send_write_tokens_to_workflows", - "send_secrets_and_variables", - "require_approval_for_fork_pr_workflows" - ], "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } } } }, "examples": { "default": { "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] } } } } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -59305,111 +59854,53 @@ } } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", "properties": { "message": { - "type": "string" + "type": [ + "string", + "null" + ] }, "documentation_url": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "detail": { + "type": [ + "string", + "null" + ] }, "status": { - "type": "string" + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "examples": { - "default": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" }, "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59434,8 +59925,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -59460,75 +59951,21 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { + "code": { + "type": "string" + }, "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } } } } @@ -59537,23 +59974,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { + "/orgs/{org}": { "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", + "summary": "Get an organization", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", "tags": [ - "actions" + "orgs" ], + "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -59572,66 +60010,598 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", - "required": [ - "enabled_repositories" - ], "properties": { - "enabled_repositories": { + "login": { "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" + "examples": [ + "github" ] }, - "selected_repositories_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] } - } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] }, "examples": { - "response": { - "summary": "Example response", + "default-response": { "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false } } } } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59658,21 +60628,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "orgs", + "subcategory": "orgs" } }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", + "patch": { + "summary": "Update an organization", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ - "actions" + "orgs" ], + "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -59686,30 +60657,173 @@ } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", - "required": [ - "enabled_repositories" - ], "properties": { - "enabled_repositories": { + "billing_email": { "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", + "description": "Billing email address. This address is not publicized." + }, + "company": { + "type": "string", + "description": "The company name." + }, + "email": { + "type": "string", + "description": "The publicly visible email address." + }, + "twitter_username": { + "type": "string", + "description": "The Twitter username of the company." + }, + "location": { + "type": "string", + "description": "The location." + }, + "name": { + "type": "string", + "description": "The shorthand name of the company." + }, + "description": { + "type": "string", + "description": "The description of the company. The maximum size is 160 characters." + }, + "has_organization_projects": { + "type": "boolean", + "description": "Whether an organization can use organization projects." + }, + "has_repository_projects": { + "type": "boolean", + "description": "Whether repositories that belong to the organization can use repository projects." + }, + "default_repository_permission": { + "type": "string", + "description": "Default permission level members have for organization repositories.", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read" + }, + "members_can_create_repositories": { + "type": "boolean", + "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "default": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_private_repositories": { + "type": "boolean", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_public_repositories": { + "type": "boolean", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_allowed_repository_creation_type": { + "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", - "selected", + "private", "none" ] + }, + "members_can_create_pages": { + "type": "boolean", + "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "description": "Whether organization members can fork private organization repositories.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", + "default": false + }, + "blog": { + "type": "string", + "examples": [ + "\"http://github.blog\"" + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, "examples": { - "application/json": { + "default": { "value": { - "enabled_repositories": "all" + "billing_email": "mona@github.com", + "company": "GitHub", + "email": "mona@github.com", + "twitter_username": "github", + "location": "San Francisco", + "name": "github", + "description": "GitHub, the company.", + "default_repository_permission": "read", + "members_can_create_repositories": true, + "members_allowed_repository_creation_type": "all" } } } @@ -59717,11 +60831,705 @@ } }, "responses": { - "204": { - "description": "No content" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Full", + "description": "Organization Full", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false + } + } + } + } + } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + } + } + } + }, + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -59745,6 +61553,52 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Delete an organization", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", + "operationId": "orgs/delete", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } }, "404": { "description": "Resource not found", @@ -59772,8 +61626,8 @@ } } }, - "409": { - "description": "Conflict", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59797,101 +61651,233 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for an organization", + "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." + }, + "total_active_caches_size_in_bytes": { + "type": "integer", + "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + } + }, + "required": [ + "total_active_caches_count", + "total_active_caches_size_in_bytes" + ] + }, + "examples": { + "default": { + "value": { + "total_active_caches_size_in_bytes": 3344284, + "total_active_caches_count": 5 + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/cache/usage-by-repository": { + "get": { + "summary": "List repositories with GitHub Actions cache usage for an organization", + "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-by-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "repository_cache_usages" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "repository_cache_usages": { "type": "array", "items": { + "title": "Actions Cache Usage by repository", + "description": "GitHub Actions Cache Usage by repository.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "full_name": { + "description": "The repository owner and name for the cache usage being shown.", + "type": "string", + "examples": [ + "octo-org/Hello-World" + ] }, - "index": { - "type": "integer" + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", + "examples": [ + 2322142 + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "examples": [ + 3 ] } - } + }, + "required": [ + "full_name", + "active_caches_size_in_bytes", + "active_caches_count" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "repository_cache_usages": [ + { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + }, + { + "full_name": "octo-org/server", + "active_caches_size_in_bytes": 1022142, + "active_caches_count": 2 + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "cache" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { + "/orgs/{org}/actions/hosted-runners": { "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "summary": "List GitHub-hosted runners for an organization", + "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -59929,1168 +61915,312 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "runners" + ], "properties": { "total_count": { "type": "integer" }, - "repositories": { + "runners": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", + "description": "The unique identifier of the hosted runner.", "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + 5 ] }, "name": { - "description": "The name of the repository.", + "description": "The name of the hosted runner.", "type": "string", "examples": [ - "Team Environment" + "my-github-hosted-runner" ] }, - "full_name": { - "type": "string", + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", "examples": [ - "octocat/Hello-World" + 2 ] }, - "license": { + "image_details": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + "ubuntu-20.04" ] }, - "spdx_id": { - "type": [ - "string", - "null" - ], + "size_gb": { + "description": "Image size in GB.", + "type": "integer", "examples": [ - "MIT" + 86 ] }, - "node_id": { + "display_name": { + "description": "Display name for this image.", "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + 20.04 ] }, - "html_url": { + "source": { + "description": "The image provider.", "type": "string", - "format": "uri" + "enum": [ + "github", + "partner", + "custom" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "id", + "size_gb", + "display_name", + "source" ] } ] }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "8-core" ] }, - "type": { - "type": "string", + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", "examples": [ - "User" + 8 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 32 ] }, - "user_view_type": { - "type": "string", + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", "examples": [ - "public" + 300 ] } }, "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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true + "2022-10-09T23:39:01Z" ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + }, + { + "id": 7, + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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, - "allow_auto_merge": false, - "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 + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" } ] } } } } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "string" } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + "post": { + "summary": "Create a GitHub-hosted runner for an organization", + "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/create-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -61109,27 +62239,66 @@ "application/json": { "schema": { "type": "object", - "required": [ - "selected_repository_ids" - ], "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "image": { + "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the runner image.", + "type": "string" + }, + "source": { + "description": "The source of the runner image.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + } + }, + "size": { + "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" } - } + }, + "required": [ + "name", + "image", + "size", + "runner_group_id" + ] }, "examples": { - "application/json": { + "default": { "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] + "name": "My Hosted runner", + "image": { + "id": "ubuntu-latest", + "source": "github" + }, + "runner_group_id": 1, + "size": "4-core", + "maximum_runners": 50, + "enable_static_ip": false } } } @@ -61137,155 +62306,505 @@ } }, "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "images" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" } } } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "images" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "images": { "type": "array", "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] }, - "message": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "code": { - "type": "string" + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] }, - "index": { - "type": "integer" + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" ] } - } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] } } } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "/orgs/{org}/actions/hosted-runners/limits": { + "get": { + "summary": "Get limits on GitHub-hosted runners for an organization", + "description": "Get the GitHub-hosted runners limits for an organization.", + "operationId": "actions/get-hosted-runners-limits-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -61296,191 +62815,547 @@ "schema": { "type": "string" } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 17 + ] + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } } } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + "get": { + "summary": "Get GitHub-hosted runners machine specs for an organization", + "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "machine_specs" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "machine_specs": { + "type": "array", + "items": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 } } } } } - }, - "409": { - "description": "Conflict", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/platforms": { + "get": { + "summary": "Get platforms for GitHub-hosted runners in an organization", + "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-platforms-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "platforms" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "platforms": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "get": { + "summary": "Get a GitHub-hosted runner for an organization", + "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "errors": { + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "patch": { + "summary": "Update a GitHub-hosted runner for an organization", + "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/update-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -61493,8 +63368,8 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -61502,157 +63377,284 @@ } } ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false } } } } - }, - "409": { - "description": "Conflict", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "documentation_url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "errors": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -61662,22 +63664,21 @@ }, "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - } - }, - "/organizations/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", "tags": [ - "dependabot" + "actions" ], - "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -61690,747 +63691,255 @@ } }, { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", "examples": [ - "internal" + 5 ] }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] }, - "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" + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } }, - "additionalProperties": false + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "default_level": "public", - "accessible_repositories": [ + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "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, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" - }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -62440,21 +63949,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for an organization", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -62467,113 +63978,35 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to remove." - } - }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", - "value": { - "repository_ids_to_remove": [ - 789 - ] - } - } - } - } - } - }, "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "required": [ + "include_claim_keys" + ] + }, + "examples": { + "default": { + "value": { + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -62582,24 +64015,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "oidc" } - } - }, - "/organizations/{org}/dependabot/repository-access/default-level": { + }, "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "summary": "Set the customization template for an OIDC subject claim for an organization", + "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -62617,29 +64047,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } }, "required": [ - "default_level" + "include_claim_keys" ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", + "default": { "value": { - "default_level": "public" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -62647,229 +64077,27 @@ } }, "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/organizations/{org}/settings/billing/usage": { - "get": { - "summary": "Get billing usage report for an organization", - "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).\"", - "tags": [ - "billing" - ], - "operationId": "billing/get-github-billing-usage-report-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "month", - "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "day", - "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "hour", - "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Billing usage report response for an organization", + "201": { + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "usageItems": [ - { - "date": "2023-08-01", - "product": "Actions", - "sku": "Actions Linux", - "quantity": 100, - "unitType": "minutes", - "pricePerUnit": 0.008, - "grossAmount": 0.8, - "discountAmount": 0, - "netAmount": 0.8, - "organizationName": "GitHub", - "repositoryName": "github/example" - } - ] - } + "value": null } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62891,48 +64119,6 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, @@ -62961,74 +64147,27 @@ } } } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "previews": [], + "category": "actions", + "subcategory": "oidc" } } }, - "/orgs/{org}": { + "/orgs/{org}/actions/permissions": { "get": { - "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -63047,616 +64186,45 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { + "enabled_repositories": { "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", + "enum": [ + "all", + "none", + "selected" ] }, - "members_allowed_repository_creation_type": { + "selected_repositories_url": { "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] + "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`." }, - "created_at": { + "allowed_actions": { "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] }, - "updated_at": { + "selected_actions_url": { "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "enabled_repositories" ] }, "examples": { - "default-response": { + "default": { "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } } } @@ -63665,22 +64233,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" } }, - "patch": { - "summary": "Update an organization", - "description": "> [!WARNING]\n> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -63693,880 +64261,145 @@ } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "billing_email": { - "type": "string", - "description": "Billing email address. This address is not publicized." - }, - "company": { - "type": "string", - "description": "The company name." - }, - "email": { - "type": "string", - "description": "The publicly visible email address." - }, - "twitter_username": { - "type": "string", - "description": "The Twitter username of the company." - }, - "location": { - "type": "string", - "description": "The location." - }, - "name": { - "type": "string", - "description": "The shorthand name of the company." - }, - "description": { - "type": "string", - "description": "The description of the company. The maximum size is 160 characters." - }, - "has_organization_projects": { - "type": "boolean", - "description": "Whether an organization can use organization projects." - }, - "has_repository_projects": { - "type": "boolean", - "description": "Whether repositories that belong to the organization can use repository projects." - }, - "default_repository_permission": { - "type": "string", - "description": "Default permission level members have for organization repositories.", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read" - }, - "members_can_create_repositories": { - "type": "boolean", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "default": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_private_repositories": { - "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_public_repositories": { - "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_allowed_repository_creation_type": { + "enabled_repositories": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ "all", - "private", - "none" + "none", + "selected" ] }, - "members_can_create_pages": { - "type": "boolean", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Whether organization members can fork private organization repositories.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", - "default": false - }, - "blog": { + "allowed_actions": { "type": "string", - "examples": [ - "\"http://github.blog\"" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": "string", - "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } - } + }, + "required": [ + "enabled_repositories" + ] }, "examples": { "default": { "value": { - "billing_email": "mona@github.com", - "company": "GitHub", - "email": "mona@github.com", - "twitter_username": "github", - "location": "San Francisco", - "name": "github", - "description": "GitHub, the company.", - "default_repository_permission": "read", - "members_can_create_repositories": true, - "members_allowed_repository_creation_type": "all" + "enabled_repositories": "all", + "allowed_actions": "selected" } } } } } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false + "days": 90, + "maximum_allowed_days": 365 } } } } } }, - "422": { - "description": "Validation failed", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - ] + } } } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -64593,22 +64426,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } }, - "delete": { - "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", - "operationId": "orgs/delete", + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", "tags": [ - "orgs" + "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -64621,17 +64453,57 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" + } + }, + "required": [ + "days" + ] + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, "responses": { - "202": { - "description": "Accepted", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -64663,8 +64535,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -64688,27 +64560,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage": { + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { "get": { - "summary": "Get GitHub Actions cache usage for an organization", - "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -64729,59 +64675,73 @@ "schema": { "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." - }, - "total_active_caches_size_in_bytes": { - "type": "integer", - "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." } }, "required": [ - "total_active_caches_count", - "total_active_caches_size_in_bytes" + "approval_policy" ] }, "examples": { "default": { "value": { - "total_active_caches_size_in_bytes": 3344284, - "total_active_caches_count": 5 + "approval_policy": "first_time_contributors" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/cache/usage-by-repository": { - "get": { - "summary": "List repositories with GitHub Actions cache usage for an organization", - "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -64792,129 +64752,164 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ - "total_count", - "repository_cache_usages" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repository_cache_usages": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", "type": "object", + "required": [ + "code" + ], "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "octo-org/Hello-World" - ] + "resource": { + "type": "string" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "examples": [ - 2322142 - ] + "field": { + "type": "string" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "repository_cache_usages": [ - { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - { - "full_name": "octo-org/server", - "active_caches_size_in_bytes": 1022142, - "active_caches_count": 2 } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners": { + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { "get": { - "summary": "List GitHub-hosted runners for an organization", - "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], - "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -64925,24 +64920,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -64953,311 +64930,112 @@ "schema": { "type": "object", "required": [ - "total_count", - "runners" + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" ], "properties": { - "total_count": { - "type": "integer" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runners": { - "type": "array", - "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - } + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - }, - { - "id": 7, - "name": "My hosted Windows runner", - "runner_group_id": 2, - "platform": "win-x64", - "image": { - "id": "windows-latest", - "size": 256 - }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 - }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" - } - ] + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "post": { - "summary": "Create a GitHub-hosted runner for an organization", - "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/create-hosted-runner-for-org", + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -65276,66 +65054,35 @@ "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "image": { - "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the runner image.", - "type": "string" - }, - "source": { - "description": "The source of the runner image.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - } - }, - "size": { - "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", - "type": "string" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "enable_static_ip": { - "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { "default": { "value": { - "name": "My Hosted runner", - "image": { - "id": "ubuntu-latest", - "source": "github" - }, - "runner_group_id": 1, - "size": "4-core", - "maximum_runners": 50, - "enable_static_ip": false + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } @@ -65343,245 +65090,130 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] + "documentation_url": { + "type": "string" }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] + "documentation_url": { + "type": "string" }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "url": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", + "required": [ + "code" + ], "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] + "resource": { + "type": "string" }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] + "field": { + "type": "string" }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } } } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -65591,23 +65223,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/permissions/repositories": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -65618,6 +65249,24 @@ "schema": { "type": "string" } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -65629,180 +65278,961 @@ "type": "object", "required": [ "total_count", - "images" + "repositories" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "images": { + "repositories": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", "examples": [ - "ubuntu-20.04" + 108 ] }, - "platform": { - "description": "The operating system of the image.", + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "linux-x64" + "master" ] }, - "size_gb": { - "description": "Image size in GB.", + "open_issues_count": { "type": "integer", "examples": [ - 86 + 0 ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true ] - } - }, - "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/hosted-runners/images/partner": { - "get": { - "summary": "Get partner images for GitHub-hosted runners in an organization", - "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-partner-images-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "images" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "images": { - "type": "array", - "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", "examples": [ - "ubuntu-20.04" + true ] }, - "platform": { - "description": "The operating system of the image.", - "type": "string", + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", "examples": [ - "linux-x64" + true ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, "examples": [ - 86 + true ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", "enum": [ - "github", - "partner", - "custom" + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "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", - "platform", - "size_gb", - "display_name", - "source" + "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" ] } } @@ -65811,11 +66241,132 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "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, + "allow_auto_merge": false, + "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 + } + ] } } } @@ -65824,24 +66375,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/limits": { - "get": { - "summary": "Get limits on GitHub-hosted runners for an organization", - "description": "Get the GitHub-hosted runners limits for an organization.", - "operationId": "actions/get-hosted-runners-limits-for-org", + }, + "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -65855,51 +66404,37 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "public_ips": { - "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", - "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", - "type": "object", - "properties": { - "maximum": { - "type": "integer", - "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" - ] + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "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": [ - "public_ips" - ] + } }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] } } } @@ -65907,24 +66442,24 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/machine-sizes": { - "get": { - "summary": "Get GitHub-hosted runners machine specs for an organization", - "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/enable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -65935,102 +66470,39 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "machine_specs" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "machine_specs": { - "type": "array", - "items": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/platforms": { - "get": { - "summary": "Get platforms for GitHub-hosted runners in an organization", - "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-platforms-for-org", + }, + "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/disable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -66041,65 +66513,41 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "platforms" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "platforms": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "platforms": [ - "linux-x64", - "win-x64" - ] - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/orgs/{org}/actions/permissions/selected-actions": { "get": { - "summary": "Get a GitHub-hosted runner for an organization", - "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "summary": "Get allowed actions and reusable workflows for an organization", + "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-organization", "tags": [ "actions" ], - "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -66110,15 +66558,6 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -66127,272 +66566,58 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "verified_allowed": { "type": "boolean", - "examples": [ - true - ] + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "patterns_allowed": { "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } + "type": "string" } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { "default": { "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "patch": { - "summary": "Update a GitHub-hosted runner for an organization", - "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/update-hosted-runner-for-org", + "put": { + "summary": "Set allowed actions and reusable workflows for an organization", + "description": "Sets the actions and reusable workflows 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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -66403,296 +66628,46 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "verified_allowed": { + "type": "boolean", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "enable_static_ip": { - "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", + "items": { + "type": "string" + } } } }, "examples": { - "default": { + "selected_actions": { "value": { - "name": "My larger runner", - "runner_group_id": 1, - "maximum_runners": 50, - "enable_static_ip": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } @@ -66703,19 +66678,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -66726,324 +66703,92 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", + "enabled_repositories": { "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" + "all", + "selected", + "none" ] }, - "platform": { - "description": "The operating system of the image.", + "selected_repositories_url": { "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/oidc/customization/sub": { - "get": { - "summary": "Get the customization template for an OIDC subject claim for an organization", - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "oidc" - ], - "operationId": "oidc/get-oidc-custom-sub-template-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "A JSON serialized template for OIDC subject claim customization", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -67054,19 +66799,19 @@ "x-github": { "enabledForGitHubApps": true, "category": "actions", - "subcategory": "oidc" + "subcategory": "permissions" } }, "put": { - "summary": "Set the customization template for an OIDC subject claim for an organization", - "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", "tags": [ - "oidc" + "actions" ], - "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -67084,29 +66829,26 @@ "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { - "default": { + "application/json": { "value": { - "include_claim_keys": [ - "repo", - "context" - ] + "enabled_repositories": "all" } } } @@ -67114,20 +66856,30 @@ } }, "responses": { - "201": { - "description": "Empty response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -67159,8 +66911,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -67184,84 +66936,76 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } - } - }, - "/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 and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "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`." + "message": { + "type": "string" }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] + "documentation_url": { + "type": "string" }, - "selected_actions_url": { - "type": "string", - "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -67271,98 +67015,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, - "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 and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": true, - "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.", - "enum": [ - "all", - "none", - "selected" - ] - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -67400,13 +67068,9 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "repositories": { "type": "array", @@ -68496,25 +68160,76 @@ } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -68527,37 +68242,32 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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." - } + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "application/json": { "value": { "selected_repository_ids": [ - 32, - 42 + 1, + 2, + 3 ] } } @@ -68565,25 +68275,156 @@ } } }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/enable-selected-repository-github-actions-organization", + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -68607,26 +68448,178 @@ ], "responses": { "204": { - "description": "Response" + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/disable-selected-repository-github-actions-organization", + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -68650,148 +68643,156 @@ ], "responses": { "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/selected-actions": { - "get": { - "summary": "Get allowed actions and reusable workflows for an organization", - "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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." + "message": { + "type": "string" }, - "verified_allowed": { - "type": "boolean", - "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." + "documentation_url": { + "type": "string" }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set allowed actions and reusable workflows for an organization", - "description": "Sets the actions and reusable workflows 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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": false, - "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 from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", - "items": { + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { "type": "string" } } } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } @@ -68800,7 +68801,6 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } @@ -86862,9 +86862,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -97241,6 +97241,14 @@ "type": "string" } }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, { "name": "has", "in": "query", @@ -1076796,6 +1076804,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1076807,6 +1076818,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -1076870,6 +1076884,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1076881,6 +1076898,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index e3946fece4..df9966ea08 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1036,7 +1036,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &98 + schema: &95 title: Validation Error Simple description: Validation Error Simple type: object @@ -1829,7 +1829,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &97 + schema: &94 title: Validation Error description: Validation Error type: object @@ -5384,7 +5384,7 @@ paths: responses: '202': *37 '422': *7 - '500': &94 + '500': &91 description: Internal Error content: application/json: @@ -7317,8 +7317,7 @@ paths: parameters: - &40 name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -16296,643 +16295,6 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - &90 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: &321 - type: object - properties: - days: - type: integer - description: The number of days artifacts and logs are retained - maximum_allowed_days: - type: integer - description: The maximum number of days that can be configured - required: - - days - - maximum_allowed_days - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: &322 - type: object - properties: - days: - type: integer - description: The number of days to retain artifacts and logs - required: - - days - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *90 - responses: - '200': - description: Response - content: - application/json: - schema: &91 - type: object - properties: - approval_policy: - type: string - enum: - - first_time_contributors_new_to_github - - first_time_contributors - - all_external_contributors - description: The policy that controls when fork PR workflows require - approval from a maintainer. - required: - - approval_policy - examples: - default: &323 - value: - approval_policy: first_time_contributors - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *90 - responses: - '204': - description: Response - '404': *6 - '422': *15 - requestBody: - required: true - content: - application/json: - schema: *91 - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *90 - responses: - '200': - description: Response - content: - application/json: - schema: &324 - type: object - required: - - run_workflows_from_fork_pull_requests - - send_write_tokens_to_workflows - - send_secrets_and_variables - - require_approval_for_fork_pr_workflows - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from - forks are allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or - submit approving pull request reviews from a workflow triggered - by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to - workflows triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from - forks require approval from a repository administrator to run. - examples: - default: &92 - value: - run_workflows_from_fork_pull_requests: true - send_write_tokens_to_workflows: false - send_secrets_and_variables: false - require_approval_for_fork_pr_workflows: true - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: &325 - type: object - required: - - run_workflows_from_fork_pull_requests - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from forks - are allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or - submit approving pull request reviews from a workflow triggered - by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to - workflows triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from forks - require approval from a repository administrator to run. - examples: - default: *92 - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: *3 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - *90 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - repositories: - type: array - items: *59 - examples: - default: &109 - 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 - allow_auto_merge: false - 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 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - - &93 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - - *93 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -16948,7 +16310,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *90 + - &90 + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string - name: page in: query description: The page number of results to fetch. @@ -17324,7 +16692,7 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -17357,7 +16725,7 @@ paths: description: Response content: application/json: - schema: &95 + schema: &92 title: Organization Full description: Organization Full type: object @@ -17752,7 +17120,7 @@ paths: - updated_at - archived_at examples: - default-response: &96 + default-response: &93 value: login: github id: 1 @@ -18069,17 +17437,17 @@ paths: description: Response content: application/json: - schema: *95 + schema: *92 examples: - default: *96 + default: *93 '422': description: Validation failed content: application/json: schema: oneOf: - - *97 - - *98 + - *94 + - *95 '409': *45 x-github: githubCloudOnly: false @@ -18269,7 +17637,7 @@ paths: type: integer runners: type: array - items: &99 + items: &96 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18326,7 +17694,7 @@ paths: - size_gb - display_name - source - machine_size_details: &102 + machine_size_details: &99 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18558,9 +17926,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: &103 + default: &100 value: id: 5 name: My hosted ubuntu runner @@ -18615,7 +17983,7 @@ paths: type: integer images: type: array - items: &100 + items: &97 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18655,7 +18023,7 @@ paths: - display_name - source examples: - default: &101 + default: &98 value: id: ubuntu-20.04 platform: linux-x64 @@ -18695,9 +18063,9 @@ paths: type: integer images: type: array - items: *100 + items: *97 examples: - default: *101 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18785,7 +18153,7 @@ paths: type: integer machine_specs: type: array - items: *102 + items: *99 examples: default: value: @@ -18855,7 +18223,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *90 - - &104 + - &101 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18867,9 +18235,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: *103 + default: *100 headers: Link: *57 x-github: @@ -18890,7 +18258,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *90 - - *104 + - *101 requestBody: required: true content: @@ -18928,9 +18296,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: *103 + default: *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18947,15 +18315,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *90 - - *104 + - *101 responses: '202': description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: *103 + default: *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18981,7 +18349,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &105 + schema: &102 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18995,7 +18363,7 @@ paths: required: - include_claim_keys examples: - default: &106 + default: &103 value: include_claim_keys: - repo @@ -19022,9 +18390,9 @@ paths: required: true content: application/json: - schema: *105 + schema: *102 examples: - default: *106 + default: *103 responses: '201': description: Empty response @@ -19069,7 +18437,7 @@ paths: schema: type: object properties: - enabled_repositories: &107 + enabled_repositories: &104 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19082,7 +18450,7 @@ paths: 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: &108 + allowed_actions: &105 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19132,8 +18500,8 @@ paths: schema: type: object properties: - enabled_repositories: *107 - allowed_actions: *108 + enabled_repositories: *104 + allowed_actions: *105 required: - enabled_repositories examples: @@ -19146,6 +18514,277 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &321 + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &322 + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &106 + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require + approval from a maintainer. + required: + - approval_policy + examples: + default: &323 + value: + approval_policy: first_time_contributors + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *106 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &324 + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from + forks are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from + forks require approval from a repository administrator to run. + examples: + default: &107 + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &325 + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks + are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks + require approval from a repository administrator to run. + examples: + default: *107 + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: *3 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -19180,7 +18819,127 @@ paths: type: array items: *59 examples: - default: *109 + default: &111 + 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 + allow_auto_merge: false + 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 @@ -19245,7 +19004,13 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - *93 + - &108 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -19268,7 +19033,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - *93 + - *108 responses: '204': description: Response @@ -19297,7 +19062,7 @@ paths: description: Response content: application/json: - schema: &110 + schema: &109 type: object properties: github_owned_allowed: @@ -19319,7 +19084,7 @@ paths: items: type: string examples: - default: &111 + default: &110 value: github_owned_allowed: true verified_allowed: false @@ -19352,14 +19117,248 @@ paths: required: false content: application/json: - schema: *110 + schema: *109 examples: - selected_actions: *111 + selected_actions: *110 x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *59 + examples: + default: *111 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *108 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *108 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -19881,7 +19880,7 @@ paths: type: number runners: type: array - items: *99 + items: *96 examples: default: *118 headers: @@ -20225,7 +20224,7 @@ paths: parameters: - *90 - *116 - - *93 + - *108 responses: '204': description: Response @@ -20249,7 +20248,7 @@ paths: parameters: - *90 - *116 - - *93 + - *108 responses: '204': description: Response @@ -24476,9 +24475,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -25778,7 +25777,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -25844,7 +25843,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25899,7 +25898,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25953,7 +25952,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26550,7 +26549,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -26812,7 +26811,7 @@ paths: site_admin: false headers: Link: *57 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -26887,7 +26886,7 @@ paths: default: value: seats_created: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -26965,7 +26964,7 @@ paths: default: value: seats_cancelled: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -27044,7 +27043,7 @@ paths: default: value: seats_created: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -27122,7 +27121,7 @@ paths: default: value: seats_cancelled: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -27607,7 +27606,7 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *94 + '500': *91 '403': *27 '404': *6 '422': &278 @@ -27643,6 +27642,13 @@ paths: - *153 - *154 - *155 + - name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string - *156 - *157 - *158 @@ -30644,7 +30650,7 @@ paths: examples: default: *196 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -30679,7 +30685,7 @@ paths: responses: '202': *37 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -30854,7 +30860,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -30936,7 +30942,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -33580,7 +33586,7 @@ paths: examples: - token_id[]=1,token_id[]=2 responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -33777,7 +33783,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -33839,7 +33845,7 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -33875,7 +33881,7 @@ paths: - *17 - *19 responses: - '500': *94 + '500': *91 '404': *6 '403': *27 '200': @@ -33921,7 +33927,7 @@ paths: - *220 - *221 responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -34105,7 +34111,7 @@ paths: - 1296269 - 1296280 responses: - '500': *94 + '500': *91 '404': *6 '202': *37 '403': *27 @@ -34158,7 +34164,7 @@ paths: value: action: revoke responses: - '500': *94 + '500': *91 '404': *6 '204': *145 '403': *27 @@ -34192,7 +34198,7 @@ paths: - *17 - *19 responses: - '500': *94 + '500': *91 '404': *6 '403': *27 '200': @@ -38018,7 +38024,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -38168,7 +38174,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -38321,7 +38327,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38499,7 +38505,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38541,7 +38547,7 @@ paths: examples: default: *257 '404': *6 - '500': *94 + '500': *91 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -38631,7 +38637,7 @@ paths: examples: default: *257 '404': *6 - '500': *94 + '500': *91 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -38658,7 +38664,7 @@ paths: '204': description: Response '404': *6 - '500': *94 + '500': *91 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -38728,7 +38734,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38812,7 +38818,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40586,7 +40592,7 @@ paths: items: *276 examples: default: *277 - '500': *94 + '500': *91 '403': *27 '404': *6 '422': *278 @@ -44760,8 +44766,8 @@ paths: application/json: schema: oneOf: - - *97 - - *98 + - *94 + - *95 '503': description: Response content: @@ -47660,7 +47666,7 @@ paths: enabled: &318 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *108 + allowed_actions: *105 selected_actions_url: *317 required: - enabled @@ -47701,7 +47707,7 @@ paths: type: object properties: enabled: *318 - allowed_actions: *108 + allowed_actions: *105 required: - enabled examples: @@ -47883,7 +47889,7 @@ paths: description: Response content: application/json: - schema: *91 + schema: *106 examples: default: *323 '404': *6 @@ -47915,7 +47921,7 @@ paths: required: true content: application/json: - schema: *91 + schema: *106 examples: default: summary: Set approval policy to first time contributors @@ -47948,7 +47954,7 @@ paths: application/json: schema: *324 examples: - default: *92 + default: *107 '403': *27 '404': *6 x-github: @@ -47976,7 +47982,7 @@ paths: application/json: schema: *325 examples: - default: *92 + default: *107 responses: '204': description: Empty response for successful settings update @@ -48007,9 +48013,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *109 examples: - default: *111 + default: *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -48037,9 +48043,9 @@ paths: required: false content: application/json: - schema: *110 + schema: *109 examples: - selected_actions: *111 + selected_actions: *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50234,7 +50240,7 @@ paths: '204': description: Response '403': *27 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61251,7 +61257,7 @@ paths: start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop recent_folders: [] - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -61418,7 +61424,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *94 + '500': *91 '400': *14 '401': *23 '403': *27 @@ -61499,7 +61505,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -62382,7 +62388,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *97 + schema: *94 '403': *27 x-github: triggersNotification: true @@ -63122,7 +63128,7 @@ paths: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: Link: *57 - '500': *94 + '500': *91 '400': *14 '404': *6 '409': *45 @@ -64294,7 +64300,7 @@ paths: ..... '422': *15 '404': *6 - '500': *94 + '500': *91 '503': *62 '409': *45 x-github: @@ -65458,7 +65464,7 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -70918,7 +70924,7 @@ paths: application/json: schema: oneOf: - - *97 + - *94 - *471 x-github: githubCloudOnly: false @@ -82790,7 +82796,7 @@ paths: content: application/json: schema: *3 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -83427,7 +83433,7 @@ paths: headers: Link: *57 '422': *15 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -87294,7 +87300,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -87406,7 +87412,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -87437,7 +87443,7 @@ paths: examples: default: *559 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87468,7 +87474,7 @@ paths: examples: default: *562 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87519,7 +87525,7 @@ paths: examples: default: *563 '404': *6 - '500': *94 + '500': *91 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -87602,7 +87608,7 @@ paths: examples: default: *563 '404': *6 - '500': *94 + '500': *91 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -87630,7 +87636,7 @@ paths: '204': description: Response '404': *6 - '500': *94 + '500': *91 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -87663,7 +87669,7 @@ paths: examples: default: *564 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87732,7 +87738,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89493,7 +89499,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *97 + schema: *94 examples: invalid_state_transition: value: @@ -96049,7 +96055,7 @@ paths: examples: default: *196 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96510,7 +96516,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96563,7 +96569,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96597,7 +96603,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96630,7 +96636,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96660,7 +96666,7 @@ paths: examples: default: *418 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96742,7 +96748,7 @@ paths: responses: '202': *37 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96834,7 +96840,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96914,7 +96920,7 @@ paths: examples: default: *621 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -97808,7 +97814,7 @@ paths: examples: default: *418 '304': *35 - '500': *94 + '500': *91 '400': *14 '401': *23 '402': @@ -97847,7 +97853,7 @@ paths: schema: *195 examples: default: *418 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -98903,7 +98909,7 @@ paths: type: array items: *59 examples: - default: *109 + default: *111 headers: Link: *57 '404': *6 @@ -98928,7 +98934,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *93 + - *108 responses: '204': description: Response @@ -98954,7 +98960,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *93 + - *108 responses: '204': description: Response @@ -104370,7 +104376,7 @@ paths: repositoryName: user/example '400': *14 '403': *27 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -152420,6 +152426,8 @@ webhooks: type: string title: type: string + title_html: + type: string duration: type: - number @@ -152428,6 +152436,8 @@ webhooks: type: - string - 'null' + completed: + type: boolean required: - id - title diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 6b11f2e8df..c9210306f9 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -18194,7 +18194,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -18654,7 +18654,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19381,7 +19381,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19799,7 +19799,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20209,7 +20209,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20868,7 +20868,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21059,7 +21059,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21226,7 +21226,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21692,7 +21692,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22486,7 +22486,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24482,7 +24482,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58630,17 +58630,17 @@ } } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { + "/organizations/{org}/dependabot/repository-access": { "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -58651,6 +58651,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } } ], "responses": { @@ -58659,28 +58682,666 @@ "content": { "application/json": { "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days artifacts and logs are retained" + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] }, - "maximum_allowed_days": { - "type": "integer", - "description": "The maximum number of days that can be configured" + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ] + } } }, - "required": [ - "days", - "maximum_allowed_days" - ] + "additionalProperties": false }, "examples": { - "response": { - "summary": "Example response", + "default": { "value": { - "days": 90, - "maximum_allowed_days": 365 + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] } } } @@ -58741,21 +59402,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/update-repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -58775,19 +59437,50 @@ "schema": { "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days to retain artifacts and logs" + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." } }, - "required": [ - "days" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "application/json": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "days": 100 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] } } } @@ -58796,7 +59489,7 @@ }, "responses": { "204": { - "description": "No content" + "description": "Response" }, "403": { "description": "Forbidden", @@ -58849,127 +59542,27 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", + "/organizations/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -58982,40 +59575,46 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } }, - "examples": { - "default": { - "value": { - "approval_policy": "first_time_contributors" - } + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" } } } } + } + }, + "responses": { + "204": { + "description": "Response" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59039,39 +59638,6 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -59098,133 +59664,27 @@ } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] - }, - "examples": { - "default": { - "summary": "Set approval policy to first time contributors", - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { + "/organizations/{org}/settings/billing/usage": { "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", + "summary": "Get billing usage report for an organization", + "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).\"", "tags": [ - "actions" + "billing" ], + "operationId": "billing/get-github-billing-usage-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -59235,55 +59695,144 @@ "schema": { "type": "string" } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response", + "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests", - "send_write_tokens_to_workflows", - "send_secrets_and_variables", - "require_approval_for_fork_pr_workflows" - ], "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } } } }, "examples": { "default": { "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] } } } } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -59305,111 +59854,53 @@ } } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", "properties": { "message": { - "type": "string" + "type": [ + "string", + "null" + ] }, "documentation_url": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "detail": { + "type": [ + "string", + "null" + ] }, "status": { - "type": "string" + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "examples": { - "default": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" }, "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59434,8 +59925,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -59460,75 +59951,21 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { + "code": { + "type": "string" + }, "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } } } } @@ -59537,23 +59974,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { + "/orgs/{org}": { "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", + "summary": "Get an organization", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", "tags": [ - "actions" + "orgs" ], + "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -59572,66 +60010,598 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", - "required": [ - "enabled_repositories" - ], "properties": { - "enabled_repositories": { + "login": { "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" + "examples": [ + "github" ] }, - "selected_repositories_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] } - } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] }, "examples": { - "response": { - "summary": "Example response", + "default-response": { "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false } } } } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59658,21 +60628,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "orgs", + "subcategory": "orgs" } }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", + "patch": { + "summary": "Update an organization", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ - "actions" + "orgs" ], + "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -59686,30 +60657,173 @@ } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", - "required": [ - "enabled_repositories" - ], "properties": { - "enabled_repositories": { + "billing_email": { "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", + "description": "Billing email address. This address is not publicized." + }, + "company": { + "type": "string", + "description": "The company name." + }, + "email": { + "type": "string", + "description": "The publicly visible email address." + }, + "twitter_username": { + "type": "string", + "description": "The Twitter username of the company." + }, + "location": { + "type": "string", + "description": "The location." + }, + "name": { + "type": "string", + "description": "The shorthand name of the company." + }, + "description": { + "type": "string", + "description": "The description of the company. The maximum size is 160 characters." + }, + "has_organization_projects": { + "type": "boolean", + "description": "Whether an organization can use organization projects." + }, + "has_repository_projects": { + "type": "boolean", + "description": "Whether repositories that belong to the organization can use repository projects." + }, + "default_repository_permission": { + "type": "string", + "description": "Default permission level members have for organization repositories.", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read" + }, + "members_can_create_repositories": { + "type": "boolean", + "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "default": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_private_repositories": { + "type": "boolean", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_public_repositories": { + "type": "boolean", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_allowed_repository_creation_type": { + "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", - "selected", + "private", "none" ] + }, + "members_can_create_pages": { + "type": "boolean", + "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "description": "Whether organization members can fork private organization repositories.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", + "default": false + }, + "blog": { + "type": "string", + "examples": [ + "\"http://github.blog\"" + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, "examples": { - "application/json": { + "default": { "value": { - "enabled_repositories": "all" + "billing_email": "mona@github.com", + "company": "GitHub", + "email": "mona@github.com", + "twitter_username": "github", + "location": "San Francisco", + "name": "github", + "description": "GitHub, the company.", + "default_repository_permission": "read", + "members_can_create_repositories": true, + "members_allowed_repository_creation_type": "all" } } } @@ -59717,11 +60831,705 @@ } }, "responses": { - "204": { - "description": "No content" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Full", + "description": "Organization Full", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false + } + } + } + } + } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + } + } + } + }, + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -59745,6 +61553,52 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Delete an organization", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", + "operationId": "orgs/delete", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } }, "404": { "description": "Resource not found", @@ -59772,8 +61626,8 @@ } } }, - "409": { - "description": "Conflict", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59797,101 +61651,233 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for an organization", + "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." + }, + "total_active_caches_size_in_bytes": { + "type": "integer", + "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + } + }, + "required": [ + "total_active_caches_count", + "total_active_caches_size_in_bytes" + ] + }, + "examples": { + "default": { + "value": { + "total_active_caches_size_in_bytes": 3344284, + "total_active_caches_count": 5 + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/cache/usage-by-repository": { + "get": { + "summary": "List repositories with GitHub Actions cache usage for an organization", + "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-by-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "repository_cache_usages" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "repository_cache_usages": { "type": "array", "items": { + "title": "Actions Cache Usage by repository", + "description": "GitHub Actions Cache Usage by repository.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "full_name": { + "description": "The repository owner and name for the cache usage being shown.", + "type": "string", + "examples": [ + "octo-org/Hello-World" + ] }, - "index": { - "type": "integer" + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", + "examples": [ + 2322142 + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "examples": [ + 3 ] } - } + }, + "required": [ + "full_name", + "active_caches_size_in_bytes", + "active_caches_count" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "repository_cache_usages": [ + { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + }, + { + "full_name": "octo-org/server", + "active_caches_size_in_bytes": 1022142, + "active_caches_count": 2 + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "cache" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { + "/orgs/{org}/actions/hosted-runners": { "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "summary": "List GitHub-hosted runners for an organization", + "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -59929,1168 +61915,312 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "runners" + ], "properties": { "total_count": { "type": "integer" }, - "repositories": { + "runners": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", + "description": "The unique identifier of the hosted runner.", "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + 5 ] }, "name": { - "description": "The name of the repository.", + "description": "The name of the hosted runner.", "type": "string", "examples": [ - "Team Environment" + "my-github-hosted-runner" ] }, - "full_name": { - "type": "string", + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", "examples": [ - "octocat/Hello-World" + 2 ] }, - "license": { + "image_details": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + "ubuntu-20.04" ] }, - "spdx_id": { - "type": [ - "string", - "null" - ], + "size_gb": { + "description": "Image size in GB.", + "type": "integer", "examples": [ - "MIT" + 86 ] }, - "node_id": { + "display_name": { + "description": "Display name for this image.", "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + 20.04 ] }, - "html_url": { + "source": { + "description": "The image provider.", "type": "string", - "format": "uri" + "enum": [ + "github", + "partner", + "custom" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "id", + "size_gb", + "display_name", + "source" ] } ] }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "8-core" ] }, - "type": { - "type": "string", + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", "examples": [ - "User" + 8 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 32 ] }, - "user_view_type": { - "type": "string", + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", "examples": [ - "public" + 300 ] } }, "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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true + "2022-10-09T23:39:01Z" ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + }, + { + "id": 7, + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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, - "allow_auto_merge": false, - "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 + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" } ] } } } } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "string" } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + "post": { + "summary": "Create a GitHub-hosted runner for an organization", + "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/create-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -61109,27 +62239,66 @@ "application/json": { "schema": { "type": "object", - "required": [ - "selected_repository_ids" - ], "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "image": { + "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the runner image.", + "type": "string" + }, + "source": { + "description": "The source of the runner image.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + } + }, + "size": { + "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" } - } + }, + "required": [ + "name", + "image", + "size", + "runner_group_id" + ] }, "examples": { - "application/json": { + "default": { "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] + "name": "My Hosted runner", + "image": { + "id": "ubuntu-latest", + "source": "github" + }, + "runner_group_id": 1, + "size": "4-core", + "maximum_runners": 50, + "enable_static_ip": false } } } @@ -61137,155 +62306,505 @@ } }, "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "images" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" } } } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "images" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "images": { "type": "array", "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] }, - "message": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "code": { - "type": "string" + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] }, - "index": { - "type": "integer" + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" ] } - } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] } } } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "/orgs/{org}/actions/hosted-runners/limits": { + "get": { + "summary": "Get limits on GitHub-hosted runners for an organization", + "description": "Get the GitHub-hosted runners limits for an organization.", + "operationId": "actions/get-hosted-runners-limits-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -61296,191 +62815,547 @@ "schema": { "type": "string" } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 17 + ] + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } } } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + "get": { + "summary": "Get GitHub-hosted runners machine specs for an organization", + "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "machine_specs" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "machine_specs": { + "type": "array", + "items": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 } } } } } - }, - "409": { - "description": "Conflict", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/platforms": { + "get": { + "summary": "Get platforms for GitHub-hosted runners in an organization", + "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-platforms-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "platforms" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "platforms": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "get": { + "summary": "Get a GitHub-hosted runner for an organization", + "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "errors": { + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "patch": { + "summary": "Update a GitHub-hosted runner for an organization", + "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/update-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -61493,8 +63368,8 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -61502,157 +63377,284 @@ } } ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false } } } } - }, - "409": { - "description": "Conflict", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "documentation_url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "errors": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -61662,22 +63664,21 @@ }, "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - } - }, - "/organizations/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", "tags": [ - "dependabot" + "actions" ], - "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -61690,747 +63691,255 @@ } }, { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", "examples": [ - "internal" + 5 ] }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] }, - "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" + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } }, - "additionalProperties": false + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "default_level": "public", - "accessible_repositories": [ + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "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, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" - }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -62440,21 +63949,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for an organization", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -62467,113 +63978,35 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to remove." - } - }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", - "value": { - "repository_ids_to_remove": [ - 789 - ] - } - } - } - } - } - }, "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "required": [ + "include_claim_keys" + ] + }, + "examples": { + "default": { + "value": { + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -62582,24 +64015,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "oidc" } - } - }, - "/organizations/{org}/dependabot/repository-access/default-level": { + }, "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "summary": "Set the customization template for an OIDC subject claim for an organization", + "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -62617,29 +64047,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } }, "required": [ - "default_level" + "include_claim_keys" ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", + "default": { "value": { - "default_level": "public" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -62647,229 +64077,27 @@ } }, "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/organizations/{org}/settings/billing/usage": { - "get": { - "summary": "Get billing usage report for an organization", - "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).\"", - "tags": [ - "billing" - ], - "operationId": "billing/get-github-billing-usage-report-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "month", - "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "day", - "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "hour", - "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Billing usage report response for an organization", + "201": { + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "usageItems": [ - { - "date": "2023-08-01", - "product": "Actions", - "sku": "Actions Linux", - "quantity": 100, - "unitType": "minutes", - "pricePerUnit": 0.008, - "grossAmount": 0.8, - "discountAmount": 0, - "netAmount": 0.8, - "organizationName": "GitHub", - "repositoryName": "github/example" - } - ] - } + "value": null } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -62891,48 +64119,6 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, @@ -62961,74 +64147,27 @@ } } } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "previews": [], + "category": "actions", + "subcategory": "oidc" } } }, - "/orgs/{org}": { + "/orgs/{org}/actions/permissions": { "get": { - "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -63047,616 +64186,45 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { + "enabled_repositories": { "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", + "enum": [ + "all", + "none", + "selected" ] }, - "members_allowed_repository_creation_type": { + "selected_repositories_url": { "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] + "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`." }, - "created_at": { + "allowed_actions": { "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] }, - "updated_at": { + "selected_actions_url": { "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "enabled_repositories" ] }, "examples": { - "default-response": { + "default": { "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } } } @@ -63665,22 +64233,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" } }, - "patch": { - "summary": "Update an organization", - "description": "> [!WARNING]\n> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -63693,880 +64261,145 @@ } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "billing_email": { - "type": "string", - "description": "Billing email address. This address is not publicized." - }, - "company": { - "type": "string", - "description": "The company name." - }, - "email": { - "type": "string", - "description": "The publicly visible email address." - }, - "twitter_username": { - "type": "string", - "description": "The Twitter username of the company." - }, - "location": { - "type": "string", - "description": "The location." - }, - "name": { - "type": "string", - "description": "The shorthand name of the company." - }, - "description": { - "type": "string", - "description": "The description of the company. The maximum size is 160 characters." - }, - "has_organization_projects": { - "type": "boolean", - "description": "Whether an organization can use organization projects." - }, - "has_repository_projects": { - "type": "boolean", - "description": "Whether repositories that belong to the organization can use repository projects." - }, - "default_repository_permission": { - "type": "string", - "description": "Default permission level members have for organization repositories.", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read" - }, - "members_can_create_repositories": { - "type": "boolean", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "default": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_private_repositories": { - "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_public_repositories": { - "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_allowed_repository_creation_type": { + "enabled_repositories": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ "all", - "private", - "none" + "none", + "selected" ] }, - "members_can_create_pages": { - "type": "boolean", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Whether organization members can fork private organization repositories.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", - "default": false - }, - "blog": { + "allowed_actions": { "type": "string", - "examples": [ - "\"http://github.blog\"" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": "string", - "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } - } + }, + "required": [ + "enabled_repositories" + ] }, "examples": { "default": { "value": { - "billing_email": "mona@github.com", - "company": "GitHub", - "email": "mona@github.com", - "twitter_username": "github", - "location": "San Francisco", - "name": "github", - "description": "GitHub, the company.", - "default_repository_permission": "read", - "members_can_create_repositories": true, - "members_allowed_repository_creation_type": "all" + "enabled_repositories": "all", + "allowed_actions": "selected" } } } } } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false + "days": 90, + "maximum_allowed_days": 365 } } } } } }, - "422": { - "description": "Validation failed", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - ] + } } } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -64593,22 +64426,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } }, - "delete": { - "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", - "operationId": "orgs/delete", + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", "tags": [ - "orgs" + "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -64621,17 +64453,57 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" + } + }, + "required": [ + "days" + ] + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, "responses": { - "202": { - "description": "Accepted", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -64663,8 +64535,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -64688,27 +64560,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage": { + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { "get": { - "summary": "Get GitHub Actions cache usage for an organization", - "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -64729,59 +64675,73 @@ "schema": { "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." - }, - "total_active_caches_size_in_bytes": { - "type": "integer", - "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." } }, "required": [ - "total_active_caches_count", - "total_active_caches_size_in_bytes" + "approval_policy" ] }, "examples": { "default": { "value": { - "total_active_caches_size_in_bytes": 3344284, - "total_active_caches_count": 5 + "approval_policy": "first_time_contributors" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/cache/usage-by-repository": { - "get": { - "summary": "List repositories with GitHub Actions cache usage for an organization", - "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -64792,129 +64752,164 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ - "total_count", - "repository_cache_usages" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repository_cache_usages": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", "type": "object", + "required": [ + "code" + ], "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "octo-org/Hello-World" - ] + "resource": { + "type": "string" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "examples": [ - 2322142 - ] + "field": { + "type": "string" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "repository_cache_usages": [ - { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - { - "full_name": "octo-org/server", - "active_caches_size_in_bytes": 1022142, - "active_caches_count": 2 } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners": { + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { "get": { - "summary": "List GitHub-hosted runners for an organization", - "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], - "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -64925,24 +64920,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -64953,311 +64930,112 @@ "schema": { "type": "object", "required": [ - "total_count", - "runners" + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" ], "properties": { - "total_count": { - "type": "integer" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runners": { - "type": "array", - "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - } + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - }, - { - "id": 7, - "name": "My hosted Windows runner", - "runner_group_id": 2, - "platform": "win-x64", - "image": { - "id": "windows-latest", - "size": 256 - }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 - }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" - } - ] + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "post": { - "summary": "Create a GitHub-hosted runner for an organization", - "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/create-hosted-runner-for-org", + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -65276,66 +65054,35 @@ "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "image": { - "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the runner image.", - "type": "string" - }, - "source": { - "description": "The source of the runner image.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - } - }, - "size": { - "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", - "type": "string" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "enable_static_ip": { - "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { "default": { "value": { - "name": "My Hosted runner", - "image": { - "id": "ubuntu-latest", - "source": "github" - }, - "runner_group_id": 1, - "size": "4-core", - "maximum_runners": 50, - "enable_static_ip": false + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } @@ -65343,245 +65090,130 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] + "documentation_url": { + "type": "string" }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] + "documentation_url": { + "type": "string" }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "url": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", + "required": [ + "code" + ], "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] + "resource": { + "type": "string" }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] + "field": { + "type": "string" }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } } } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -65591,23 +65223,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/permissions/repositories": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -65618,6 +65249,24 @@ "schema": { "type": "string" } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -65629,180 +65278,961 @@ "type": "object", "required": [ "total_count", - "images" + "repositories" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "images": { + "repositories": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", "examples": [ - "ubuntu-20.04" + 108 ] }, - "platform": { - "description": "The operating system of the image.", + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "linux-x64" + "master" ] }, - "size_gb": { - "description": "Image size in GB.", + "open_issues_count": { "type": "integer", "examples": [ - 86 + 0 ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true ] - } - }, - "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/hosted-runners/images/partner": { - "get": { - "summary": "Get partner images for GitHub-hosted runners in an organization", - "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-partner-images-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "images" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "images": { - "type": "array", - "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", "examples": [ - "ubuntu-20.04" + true ] }, - "platform": { - "description": "The operating system of the image.", - "type": "string", + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", "examples": [ - "linux-x64" + true ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, "examples": [ - 86 + true ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", "enum": [ - "github", - "partner", - "custom" + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "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", - "platform", - "size_gb", - "display_name", - "source" + "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" ] } } @@ -65811,11 +66241,132 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "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, + "allow_auto_merge": false, + "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 + } + ] } } } @@ -65824,24 +66375,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/limits": { - "get": { - "summary": "Get limits on GitHub-hosted runners for an organization", - "description": "Get the GitHub-hosted runners limits for an organization.", - "operationId": "actions/get-hosted-runners-limits-for-org", + }, + "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -65855,51 +66404,37 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "public_ips": { - "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", - "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", - "type": "object", - "properties": { - "maximum": { - "type": "integer", - "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" - ] + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "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": [ - "public_ips" - ] + } }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] } } } @@ -65907,24 +66442,24 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/machine-sizes": { - "get": { - "summary": "Get GitHub-hosted runners machine specs for an organization", - "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/enable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -65935,102 +66470,39 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "machine_specs" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "machine_specs": { - "type": "array", - "items": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/platforms": { - "get": { - "summary": "Get platforms for GitHub-hosted runners in an organization", - "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-platforms-for-org", + }, + "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/disable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -66041,65 +66513,41 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "platforms" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "platforms": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "platforms": [ - "linux-x64", - "win-x64" - ] - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/orgs/{org}/actions/permissions/selected-actions": { "get": { - "summary": "Get a GitHub-hosted runner for an organization", - "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "summary": "Get allowed actions and reusable workflows for an organization", + "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-organization", "tags": [ "actions" ], - "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -66110,15 +66558,6 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -66127,272 +66566,58 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "verified_allowed": { "type": "boolean", - "examples": [ - true - ] + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "patterns_allowed": { "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } + "type": "string" } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { "default": { "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "patch": { - "summary": "Update a GitHub-hosted runner for an organization", - "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/update-hosted-runner-for-org", + "put": { + "summary": "Set allowed actions and reusable workflows for an organization", + "description": "Sets the actions and reusable workflows 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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -66403,296 +66628,46 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "verified_allowed": { + "type": "boolean", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "enable_static_ip": { - "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", + "items": { + "type": "string" + } } } }, "examples": { - "default": { + "selected_actions": { "value": { - "name": "My larger runner", - "runner_group_id": 1, - "maximum_runners": 50, - "enable_static_ip": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } @@ -66703,19 +66678,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -66726,324 +66703,92 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", + "enabled_repositories": { "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" + "all", + "selected", + "none" ] }, - "platform": { - "description": "The operating system of the image.", + "selected_repositories_url": { "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/oidc/customization/sub": { - "get": { - "summary": "Get the customization template for an OIDC subject claim for an organization", - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "oidc" - ], - "operationId": "oidc/get-oidc-custom-sub-template-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "A JSON serialized template for OIDC subject claim customization", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -67054,19 +66799,19 @@ "x-github": { "enabledForGitHubApps": true, "category": "actions", - "subcategory": "oidc" + "subcategory": "permissions" } }, "put": { - "summary": "Set the customization template for an OIDC subject claim for an organization", - "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", "tags": [ - "oidc" + "actions" ], - "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -67084,29 +66829,26 @@ "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { - "default": { + "application/json": { "value": { - "include_claim_keys": [ - "repo", - "context" - ] + "enabled_repositories": "all" } } } @@ -67114,20 +66856,30 @@ } }, "responses": { - "201": { - "description": "Empty response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -67159,8 +66911,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -67184,84 +66936,76 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } - } - }, - "/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 and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "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`." + "message": { + "type": "string" }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] + "documentation_url": { + "type": "string" }, - "selected_actions_url": { - "type": "string", - "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -67271,98 +67015,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, - "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 and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": true, - "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.", - "enum": [ - "all", - "none", - "selected" - ] - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -67400,13 +67068,9 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "repositories": { "type": "array", @@ -68496,25 +68160,76 @@ } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -68527,37 +68242,32 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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." - } + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "application/json": { "value": { "selected_repository_ids": [ - 32, - 42 + 1, + 2, + 3 ] } } @@ -68565,25 +68275,156 @@ } } }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/enable-selected-repository-github-actions-organization", + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -68607,26 +68448,178 @@ ], "responses": { "204": { - "description": "Response" + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/disable-selected-repository-github-actions-organization", + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -68650,148 +68643,156 @@ ], "responses": { "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/selected-actions": { - "get": { - "summary": "Get allowed actions and reusable workflows for an organization", - "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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." + "message": { + "type": "string" }, - "verified_allowed": { - "type": "boolean", - "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." + "documentation_url": { + "type": "string" }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set allowed actions and reusable workflows for an organization", - "description": "Sets the actions and reusable workflows 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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": false, - "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 from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", - "items": { + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { "type": "string" } } } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } @@ -68800,7 +68801,6 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } @@ -86862,9 +86862,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -97241,6 +97241,14 @@ "type": "string" } }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, { "name": "has", "in": "query", @@ -1076796,6 +1076804,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1076807,6 +1076818,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -1076870,6 +1076884,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1076881,6 +1076898,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index e3946fece4..df9966ea08 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1036,7 +1036,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &98 + schema: &95 title: Validation Error Simple description: Validation Error Simple type: object @@ -1829,7 +1829,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &97 + schema: &94 title: Validation Error description: Validation Error type: object @@ -5384,7 +5384,7 @@ paths: responses: '202': *37 '422': *7 - '500': &94 + '500': &91 description: Internal Error content: application/json: @@ -7317,8 +7317,7 @@ paths: parameters: - &40 name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -16296,643 +16295,6 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - &90 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: &321 - type: object - properties: - days: - type: integer - description: The number of days artifacts and logs are retained - maximum_allowed_days: - type: integer - description: The maximum number of days that can be configured - required: - - days - - maximum_allowed_days - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: &322 - type: object - properties: - days: - type: integer - description: The number of days to retain artifacts and logs - required: - - days - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *90 - responses: - '200': - description: Response - content: - application/json: - schema: &91 - type: object - properties: - approval_policy: - type: string - enum: - - first_time_contributors_new_to_github - - first_time_contributors - - all_external_contributors - description: The policy that controls when fork PR workflows require - approval from a maintainer. - required: - - approval_policy - examples: - default: &323 - value: - approval_policy: first_time_contributors - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *90 - responses: - '204': - description: Response - '404': *6 - '422': *15 - requestBody: - required: true - content: - application/json: - schema: *91 - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *90 - responses: - '200': - description: Response - content: - application/json: - schema: &324 - type: object - required: - - run_workflows_from_fork_pull_requests - - send_write_tokens_to_workflows - - send_secrets_and_variables - - require_approval_for_fork_pr_workflows - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from - forks are allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or - submit approving pull request reviews from a workflow triggered - by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to - workflows triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from - forks require approval from a repository administrator to run. - examples: - default: &92 - value: - run_workflows_from_fork_pull_requests: true - send_write_tokens_to_workflows: false - send_secrets_and_variables: false - require_approval_for_fork_pr_workflows: true - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: &325 - type: object - required: - - run_workflows_from_fork_pull_requests - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from forks - are allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or - submit approving pull request reviews from a workflow triggered - by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to - workflows triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from forks - require approval from a repository administrator to run. - examples: - default: *92 - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: *3 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - *90 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - repositories: - type: array - items: *59 - examples: - default: &109 - 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 - allow_auto_merge: false - 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 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - - &93 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *90 - - *93 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *45 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -16948,7 +16310,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *90 + - &90 + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string - name: page in: query description: The page number of results to fetch. @@ -17324,7 +16692,7 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -17357,7 +16725,7 @@ paths: description: Response content: application/json: - schema: &95 + schema: &92 title: Organization Full description: Organization Full type: object @@ -17752,7 +17120,7 @@ paths: - updated_at - archived_at examples: - default-response: &96 + default-response: &93 value: login: github id: 1 @@ -18069,17 +17437,17 @@ paths: description: Response content: application/json: - schema: *95 + schema: *92 examples: - default: *96 + default: *93 '422': description: Validation failed content: application/json: schema: oneOf: - - *97 - - *98 + - *94 + - *95 '409': *45 x-github: githubCloudOnly: false @@ -18269,7 +17637,7 @@ paths: type: integer runners: type: array - items: &99 + items: &96 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18326,7 +17694,7 @@ paths: - size_gb - display_name - source - machine_size_details: &102 + machine_size_details: &99 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18558,9 +17926,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: &103 + default: &100 value: id: 5 name: My hosted ubuntu runner @@ -18615,7 +17983,7 @@ paths: type: integer images: type: array - items: &100 + items: &97 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18655,7 +18023,7 @@ paths: - display_name - source examples: - default: &101 + default: &98 value: id: ubuntu-20.04 platform: linux-x64 @@ -18695,9 +18063,9 @@ paths: type: integer images: type: array - items: *100 + items: *97 examples: - default: *101 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18785,7 +18153,7 @@ paths: type: integer machine_specs: type: array - items: *102 + items: *99 examples: default: value: @@ -18855,7 +18223,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *90 - - &104 + - &101 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18867,9 +18235,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: *103 + default: *100 headers: Link: *57 x-github: @@ -18890,7 +18258,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *90 - - *104 + - *101 requestBody: required: true content: @@ -18928,9 +18296,9 @@ paths: description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: *103 + default: *100 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18947,15 +18315,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *90 - - *104 + - *101 responses: '202': description: Response content: application/json: - schema: *99 + schema: *96 examples: - default: *103 + default: *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18981,7 +18349,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &105 + schema: &102 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18995,7 +18363,7 @@ paths: required: - include_claim_keys examples: - default: &106 + default: &103 value: include_claim_keys: - repo @@ -19022,9 +18390,9 @@ paths: required: true content: application/json: - schema: *105 + schema: *102 examples: - default: *106 + default: *103 responses: '201': description: Empty response @@ -19069,7 +18437,7 @@ paths: schema: type: object properties: - enabled_repositories: &107 + enabled_repositories: &104 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19082,7 +18450,7 @@ paths: 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: &108 + allowed_actions: &105 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19132,8 +18500,8 @@ paths: schema: type: object properties: - enabled_repositories: *107 - allowed_actions: *108 + enabled_repositories: *104 + allowed_actions: *105 required: - enabled_repositories examples: @@ -19146,6 +18514,277 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &321 + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &322 + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &106 + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require + approval from a maintainer. + required: + - approval_policy + examples: + default: &323 + value: + approval_policy: first_time_contributors + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *106 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &324 + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from + forks are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from + forks require approval from a repository administrator to run. + examples: + default: &107 + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &325 + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks + are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks + require approval from a repository administrator to run. + examples: + default: *107 + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: *3 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -19180,7 +18819,127 @@ paths: type: array items: *59 examples: - default: *109 + default: &111 + 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 + allow_auto_merge: false + 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 @@ -19245,7 +19004,13 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - *93 + - &108 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -19268,7 +19033,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - *93 + - *108 responses: '204': description: Response @@ -19297,7 +19062,7 @@ paths: description: Response content: application/json: - schema: &110 + schema: &109 type: object properties: github_owned_allowed: @@ -19319,7 +19084,7 @@ paths: items: type: string examples: - default: &111 + default: &110 value: github_owned_allowed: true verified_allowed: false @@ -19352,14 +19117,248 @@ paths: required: false content: application/json: - schema: *110 + schema: *109 examples: - selected_actions: *111 + selected_actions: *110 x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *59 + examples: + default: *111 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *108 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *108 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -19881,7 +19880,7 @@ paths: type: number runners: type: array - items: *99 + items: *96 examples: default: *118 headers: @@ -20225,7 +20224,7 @@ paths: parameters: - *90 - *116 - - *93 + - *108 responses: '204': description: Response @@ -20249,7 +20248,7 @@ paths: parameters: - *90 - *116 - - *93 + - *108 responses: '204': description: Response @@ -24476,9 +24475,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -25778,7 +25777,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -25844,7 +25843,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25899,7 +25898,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25953,7 +25952,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26550,7 +26549,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -26812,7 +26811,7 @@ paths: site_admin: false headers: Link: *57 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -26887,7 +26886,7 @@ paths: default: value: seats_created: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -26965,7 +26964,7 @@ paths: default: value: seats_cancelled: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -27044,7 +27043,7 @@ paths: default: value: seats_created: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -27122,7 +27121,7 @@ paths: default: value: seats_cancelled: 5 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -27607,7 +27606,7 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *94 + '500': *91 '403': *27 '404': *6 '422': &278 @@ -27643,6 +27642,13 @@ paths: - *153 - *154 - *155 + - name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string - *156 - *157 - *158 @@ -30644,7 +30650,7 @@ paths: examples: default: *196 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -30679,7 +30685,7 @@ paths: responses: '202': *37 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -30854,7 +30860,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -30936,7 +30942,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -33580,7 +33586,7 @@ paths: examples: - token_id[]=1,token_id[]=2 responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -33777,7 +33783,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -33839,7 +33845,7 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -33875,7 +33881,7 @@ paths: - *17 - *19 responses: - '500': *94 + '500': *91 '404': *6 '403': *27 '200': @@ -33921,7 +33927,7 @@ paths: - *220 - *221 responses: - '500': *94 + '500': *91 '422': *15 '404': *6 '403': *27 @@ -34105,7 +34111,7 @@ paths: - 1296269 - 1296280 responses: - '500': *94 + '500': *91 '404': *6 '202': *37 '403': *27 @@ -34158,7 +34164,7 @@ paths: value: action: revoke responses: - '500': *94 + '500': *91 '404': *6 '204': *145 '403': *27 @@ -34192,7 +34198,7 @@ paths: - *17 - *19 responses: - '500': *94 + '500': *91 '404': *6 '403': *27 '200': @@ -38018,7 +38024,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -38168,7 +38174,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -38321,7 +38327,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38499,7 +38505,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38541,7 +38547,7 @@ paths: examples: default: *257 '404': *6 - '500': *94 + '500': *91 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -38631,7 +38637,7 @@ paths: examples: default: *257 '404': *6 - '500': *94 + '500': *91 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -38658,7 +38664,7 @@ paths: '204': description: Response '404': *6 - '500': *94 + '500': *91 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -38728,7 +38734,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38812,7 +38818,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40586,7 +40592,7 @@ paths: items: *276 examples: default: *277 - '500': *94 + '500': *91 '403': *27 '404': *6 '422': *278 @@ -44760,8 +44766,8 @@ paths: application/json: schema: oneOf: - - *97 - - *98 + - *94 + - *95 '503': description: Response content: @@ -47660,7 +47666,7 @@ paths: enabled: &318 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *108 + allowed_actions: *105 selected_actions_url: *317 required: - enabled @@ -47701,7 +47707,7 @@ paths: type: object properties: enabled: *318 - allowed_actions: *108 + allowed_actions: *105 required: - enabled examples: @@ -47883,7 +47889,7 @@ paths: description: Response content: application/json: - schema: *91 + schema: *106 examples: default: *323 '404': *6 @@ -47915,7 +47921,7 @@ paths: required: true content: application/json: - schema: *91 + schema: *106 examples: default: summary: Set approval policy to first time contributors @@ -47948,7 +47954,7 @@ paths: application/json: schema: *324 examples: - default: *92 + default: *107 '403': *27 '404': *6 x-github: @@ -47976,7 +47982,7 @@ paths: application/json: schema: *325 examples: - default: *92 + default: *107 responses: '204': description: Empty response for successful settings update @@ -48007,9 +48013,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *109 examples: - default: *111 + default: *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -48037,9 +48043,9 @@ paths: required: false content: application/json: - schema: *110 + schema: *109 examples: - selected_actions: *111 + selected_actions: *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50234,7 +50240,7 @@ paths: '204': description: Response '403': *27 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61251,7 +61257,7 @@ paths: start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop recent_folders: [] - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -61418,7 +61424,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *94 + '500': *91 '400': *14 '401': *23 '403': *27 @@ -61499,7 +61505,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -62382,7 +62388,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *97 + schema: *94 '403': *27 x-github: triggersNotification: true @@ -63122,7 +63128,7 @@ paths: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: Link: *57 - '500': *94 + '500': *91 '400': *14 '404': *6 '409': *45 @@ -64294,7 +64300,7 @@ paths: ..... '422': *15 '404': *6 - '500': *94 + '500': *91 '503': *62 '409': *45 x-github: @@ -65458,7 +65464,7 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -70918,7 +70924,7 @@ paths: application/json: schema: oneOf: - - *97 + - *94 - *471 x-github: githubCloudOnly: false @@ -82790,7 +82796,7 @@ paths: content: application/json: schema: *3 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -83427,7 +83433,7 @@ paths: headers: Link: *57 '422': *15 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -87294,7 +87300,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -87406,7 +87412,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *94 + '500': *91 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -87437,7 +87443,7 @@ paths: examples: default: *559 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87468,7 +87474,7 @@ paths: examples: default: *562 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87519,7 +87525,7 @@ paths: examples: default: *563 '404': *6 - '500': *94 + '500': *91 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -87602,7 +87608,7 @@ paths: examples: default: *563 '404': *6 - '500': *94 + '500': *91 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -87630,7 +87636,7 @@ paths: '204': description: Response '404': *6 - '500': *94 + '500': *91 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -87663,7 +87669,7 @@ paths: examples: default: *564 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87732,7 +87738,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89493,7 +89499,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *97 + schema: *94 examples: invalid_state_transition: value: @@ -96049,7 +96055,7 @@ paths: examples: default: *196 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96510,7 +96516,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96563,7 +96569,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96597,7 +96603,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96630,7 +96636,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *94 + '500': *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96660,7 +96666,7 @@ paths: examples: default: *418 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96742,7 +96748,7 @@ paths: responses: '202': *37 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96834,7 +96840,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -96914,7 +96920,7 @@ paths: examples: default: *621 '304': *35 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -97808,7 +97814,7 @@ paths: examples: default: *418 '304': *35 - '500': *94 + '500': *91 '400': *14 '401': *23 '402': @@ -97847,7 +97853,7 @@ paths: schema: *195 examples: default: *418 - '500': *94 + '500': *91 '401': *23 '403': *27 '404': *6 @@ -98903,7 +98909,7 @@ paths: type: array items: *59 examples: - default: *109 + default: *111 headers: Link: *57 '404': *6 @@ -98928,7 +98934,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *93 + - *108 responses: '204': description: Response @@ -98954,7 +98960,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *93 + - *108 responses: '204': description: Response @@ -104370,7 +104376,7 @@ paths: repositoryName: user/example '400': *14 '403': *27 - '500': *94 + '500': *91 '503': *62 x-github: githubCloudOnly: false @@ -152420,6 +152426,8 @@ webhooks: type: string title: type: string + title_html: + type: string duration: type: - number @@ -152428,6 +152436,8 @@ webhooks: type: - string - 'null' + completed: + type: boolean required: - id - title diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index eee8a7229e..4609fbd52a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -18658,7 +18658,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -18731,7 +18731,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19074,7 +19074,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19425,7 +19425,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19542,7 +19542,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19659,7 +19659,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19742,7 +19742,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19848,7 +19848,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19917,7 +19917,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20210,7 +20210,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20533,7 +20533,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20820,7 +20820,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20882,7 +20882,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20963,7 +20963,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21040,7 +21040,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21133,7 +21133,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21297,7 +21297,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21385,7 +21385,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21554,7 +21554,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21655,7 +21655,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21833,7 +21833,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22026,7 +22026,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22095,7 +22095,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22138,7 +22138,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22183,7 +22183,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22253,7 +22253,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22328,7 +22328,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22411,7 +22411,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22575,7 +22575,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22643,7 +22643,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22712,7 +22712,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22901,7 +22901,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23107,7 +23107,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23236,7 +23236,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23426,7 +23426,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23471,7 +23471,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23673,7 +23673,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23751,7 +23751,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23803,7 +23803,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23857,7 +23857,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24094,7 +24094,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24172,7 +24172,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24224,7 +24224,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24286,7 +24286,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24512,7 +24512,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24623,7 +24623,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24933,7 +24933,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -25986,7 +25986,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27039,7 +27039,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27205,7 +27205,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27280,7 +27280,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27423,7 +27423,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27630,7 +27630,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27837,7 +27837,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28007,7 +28007,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28191,7 +28191,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28342,7 +28342,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28434,7 +28434,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28470,7 +28470,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28575,7 +28575,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28694,7 +28694,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -29246,7 +29246,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -31428,7 +31428,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -31539,7 +31539,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -31670,7 +31670,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -32811,7 +32811,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -32959,7 +32959,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33148,7 +33148,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33462,7 +33462,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33527,7 +33527,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33625,7 +33625,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34021,7 +34021,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34123,7 +34123,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34544,7 +34544,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34595,7 +34595,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35065,7 +35065,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36714,7 +36714,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37174,7 +37174,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37901,7 +37901,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -38319,7 +38319,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -38729,7 +38729,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39388,7 +39388,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39579,7 +39579,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39746,7 +39746,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40212,7 +40212,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41006,7 +41006,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41157,7 +41157,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41284,7 +41284,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41535,7 +41535,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -42442,7 +42442,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -43098,7 +43098,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -45094,7 +45094,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -45195,7 +45195,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46089,7 +46089,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46254,7 +46254,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46413,7 +46413,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46539,7 +46539,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46701,7 +46701,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46747,7 +46747,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46863,7 +46863,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47090,7 +47090,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47470,7 +47470,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47698,7 +47698,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47915,7 +47915,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -48233,7 +48233,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -48330,7 +48330,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -51048,7 +51048,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -52434,7 +52434,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55154,7 +55154,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55251,7 +55251,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55435,7 +55435,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55632,7 +55632,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -57697,7 +57697,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -57994,7 +57994,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58354,7 +58354,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58496,7 +58496,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58693,7 +58693,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58968,7 +58968,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -59141,7 +59141,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -59742,7 +59742,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -59998,7 +59998,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60270,7 +60270,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60518,7 +60518,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60589,7 +60589,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60660,7 +60660,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60976,7 +60976,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -61641,7 +61641,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -94163,17 +94163,17 @@ "deprecated": true } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { + "/organizations/{org}/dependabot/repository-access": { "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -94184,6 +94184,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } } ], "responses": { @@ -94192,28 +94215,666 @@ "content": { "application/json": { "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days artifacts and logs are retained" + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] }, - "maximum_allowed_days": { - "type": "integer", - "description": "The maximum number of days that can be configured" + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ] + } } }, - "required": [ - "days", - "maximum_allowed_days" - ] + "additionalProperties": false }, "examples": { - "response": { - "summary": "Example response", + "default": { "value": { - "days": 90, - "maximum_allowed_days": 365 + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] } } } @@ -94274,21 +94935,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/update-repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -94308,19 +94970,50 @@ "schema": { "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days to retain artifacts and logs" + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." } }, - "required": [ - "days" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "application/json": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "days": 100 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] } } } @@ -94329,7 +95022,7 @@ }, "responses": { "204": { - "description": "No content" + "description": "Response" }, "403": { "description": "Forbidden", @@ -94382,214 +95075,27 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] - }, - "examples": { - "default": { - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, + "/organizations/{org}/dependabot/repository-access/default-level": { "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -94602,112 +95108,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, "requestBody": { "required": true, "content": { @@ -94715,105 +95115,36 @@ "schema": { "type": "object", "properties": { - "approval_policy": { + "default_level": { "type": "string", + "description": "The default repository access level for Dependabot updates.", "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" + "public", + "internal" ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." + "examples": [ + "internal" + ] } }, "required": [ - "approval_policy" + "default_level" ] }, "examples": { - "default": { - "summary": "Set approval policy to first time contributors", + "204": { + "summary": "Example with a 'succeeded' status.", "value": { - "approval_policy": "first_time_contributors" + "default_level": "public" } } } } } }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { - "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests", - "send_write_tokens_to_workflows", - "send_secrets_and_variables", - "require_approval_for_fork_pr_workflows" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "examples": { - "default": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - } - } - } - } + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -94869,21 +95200,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + } + }, + "/organizations/{org}/settings/billing/usage": { + "get": { + "summary": "Get billing usage report for an organization", + "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform).\"", "tags": [ - "actions" + "billing" ], + "operationId": "billing/get-github-billing-usage-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -94894,251 +95228,144 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "examples": { - "default": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - } - } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" }, - "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" } }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { + "usageItems": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" + "date": { + "type": "string", + "description": "Date of the usage line item." }, - "field": { - "type": "string" + "product": { + "type": "string", + "description": "Product name." }, - "message": { - "type": "string" + "sku": { + "type": "string", + "description": "SKU name." }, - "code": { - "type": "string" + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." }, - "index": { - "type": "integer" + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." } - } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] } } } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { - "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" - } - } }, "examples": { - "response": { - "summary": "Example response", + "default": { "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] } } } } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -95160,98 +95387,50 @@ } } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", "properties": { "message": { - "type": "string" + "type": [ + "string", + "null" + ] }, "documentation_url": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "detail": { + "type": [ + "string", + "null" + ] }, "status": { - "type": "string" + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", - "enum": [ - "all", - "selected", - "none" - ] - } - } - }, - "examples": { - "application/json": { - "value": { - "enabled_repositories": "all" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" }, "403": { "description": "Forbidden", @@ -95279,8 +95458,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -95305,101 +95484,21 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { + "code": { "type": "string" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } } } } @@ -95408,23 +95507,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { + "/orgs/{org}": { "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "summary": "Get an organization", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", "tags": [ - "actions" + "orgs" ], + "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -95435,24 +95535,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -95461,1146 +95543,2800 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", "type": "object", "properties": { - "total_count": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "repositories": { - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "examples": [ + false + ], + "deprecated": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default-response": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "archived_at": null, + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false, + "secret_scanning_validity_checks_enabled": false + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "patch": { + "summary": "Update an organization", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billing_email": { + "type": "string", + "description": "Billing email address. This address is not publicized." + }, + "company": { + "type": "string", + "description": "The company name." + }, + "email": { + "type": "string", + "description": "The publicly visible email address." + }, + "twitter_username": { + "type": "string", + "description": "The Twitter username of the company." + }, + "location": { + "type": "string", + "description": "The location." + }, + "name": { + "type": "string", + "description": "The shorthand name of the company." + }, + "description": { + "type": "string", + "description": "The description of the company. The maximum size is 160 characters." + }, + "has_organization_projects": { + "type": "boolean", + "description": "Whether an organization can use organization projects." + }, + "has_repository_projects": { + "type": "boolean", + "description": "Whether repositories that belong to the organization can use repository projects." + }, + "default_repository_permission": { + "type": "string", + "description": "Default permission level members have for organization repositories.", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read" + }, + "members_can_create_repositories": { + "type": "boolean", + "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "default": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_private_repositories": { + "type": "boolean", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_public_repositories": { + "type": "boolean", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_allowed_repository_creation_type": { + "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "enum": [ + "all", + "private", + "none" + ] + }, + "members_can_create_pages": { + "type": "boolean", + "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "description": "Whether organization members can fork private organization repositories.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", + "default": false + }, + "blog": { + "type": "string", + "examples": [ + "\"http://github.blog\"" + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "deprecated": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + } + } + }, + "examples": { + "default": { + "value": { + "billing_email": "mona@github.com", + "company": "GitHub", + "email": "mona@github.com", + "twitter_username": "github", + "location": "San Francisco", + "name": "github", + "description": "GitHub, the company.", + "default_repository_permission": "read", + "members_can_create_repositories": true, + "members_allowed_repository_creation_type": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Full", + "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "examples": [ + false + ], + "deprecated": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "archived_at": null, + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false, + "secret_scanning_validity_checks_enabled": false + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Delete an organization", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service", + "operationId": "orgs/delete", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for an organization", + "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." + }, + "total_active_caches_size_in_bytes": { + "type": "integer", + "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + } + }, + "required": [ + "total_active_caches_count", + "total_active_caches_size_in_bytes" + ] + }, + "examples": { + "default": { + "value": { + "total_active_caches_size_in_bytes": 3344284, + "total_active_caches_count": 5 + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/cache/usage-by-repository": { + "get": { + "summary": "List repositories with GitHub Actions cache usage for an organization", + "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-by-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repository_cache_usages" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repository_cache_usages": { + "type": "array", + "items": { + "title": "Actions Cache Usage by repository", + "description": "GitHub Actions Cache Usage by repository.", + "type": "object", + "properties": { + "full_name": { + "description": "The repository owner and name for the cache usage being shown.", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "octo-org/Hello-World" ] }, - "subscription_url": { - "type": "string", - "format": "uri", + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + 2322142 ] }, - "tags_url": { - "type": "string", - "format": "uri", + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + 3 ] - }, - "teams_url": { - "type": "string", - "format": "uri", + } + }, + "required": [ + "full_name", + "active_caches_size_in_bytes", + "active_caches_count" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "repository_cache_usages": [ + { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + }, + { + "full_name": "octo-org/server", + "active_caches_size_in_bytes": 1022142, + "active_caches_count": 2 + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners for an organization", + "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-hosted-runners-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + 5 ] }, - "trees_url": { + "name": { + "description": "The name of the hosted runner.", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "my-github-hosted-runner" ] }, - "clone_url": { - "type": "string", + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", "examples": [ - "https://github.com/octocat/Hello-World.git" + 2 ] }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:06:43Z" + "2022-10-09T23:39:01Z" ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + }, + { + "id": 7, + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 }, - "temp_clone_token": { - "type": "string" + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "post": { + "summary": "Create a GitHub-hosted runner for an organization", + "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/create-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "image": { + "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the runner image.", + "type": "string" + }, + "source": { + "description": "The source of the runner image.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + } + }, + "size": { + "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" + } + }, + "required": [ + "name", + "image", + "size", + "runner_group_id" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Hosted runner", + "image": { + "id": "ubuntu-latest", + "source": "github" + }, + "runner_group_id": 1, + "size": "4-core", + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", "type": "boolean", "examples": [ true ] }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "20.80.208.150" ] }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", + "length": { + "description": "The length of the IP prefix.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:42Z\"" + 28 ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } - }, - "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" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ { - "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 + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] }, - "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 + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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" + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ] + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } } } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" } } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "images" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" } } } @@ -96609,21 +98345,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + } + }, + "/orgs/{org}/actions/hosted-runners/limits": { + "get": { + "summary": "Get limits on GitHub-hosted runners for an organization", + "description": "Get the GitHub-hosted runners limits for an organization.", + "operationId": "actions/get-hosted-runners-limits-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -96636,189 +98375,183 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "selected_repository_ids" - ], - "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" - } - } - }, - "examples": { - "application/json": { - "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] - } - } - } - } - } - }, "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 17 + ] + } + }, + "required": [ + "maximum", + "current_usage" + ] } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } } } } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + "get": { + "summary": "Get GitHub-hosted runners machine specs for an organization", + "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "machine_specs" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "machine_specs": { "type": "array", "items": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] }, - "code": { - "type": "string" + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] }, - "index": { - "type": "integer" + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 ] } - } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] } } } + }, + "examples": { + "default": { + "value": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + } + } } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "/orgs/{org}/actions/hosted-runners/platforms": { + "get": { + "summary": "Get platforms for GitHub-hosted runners in an organization", + "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-platforms-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -96829,191 +98562,358 @@ "schema": { "type": "string" } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "platforms" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "platforms": { + "type": "array", + "items": { + "type": "string" + } } } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "get": { + "summary": "Get a GitHub-hosted runner for an organization", + "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "409": { - "description": "Conflict", + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "documentation_url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "errors": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "patch": { + "summary": "Update a GitHub-hosted runner for an organization", + "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/update-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97026,8 +98926,8 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -97035,157 +98935,284 @@ } } ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false } } } } - }, - "409": { - "description": "Conflict", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "documentation_url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "errors": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -97195,22 +99222,21 @@ }, "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - } - }, - "/organizations/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", "tags": [ - "dependabot" + "actions" ], - "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97223,747 +99249,255 @@ } }, { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", "examples": [ - "internal" + 5 ] }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "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" - ] - } - ] - } - } - }, - "additionalProperties": false - }, - "examples": { - "default": { - "value": { - "default_level": "public", - "accessible_repositories": [ + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "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, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] }, - "url": { - "type": "string" + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } }, - "status": { - "type": "string" + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -97973,21 +99507,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for an organization", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -98000,113 +99536,35 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to remove." - } - }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", - "value": { - "repository_ids_to_remove": [ - 789 - ] - } - } - } - } - } - }, "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "required": [ + "include_claim_keys" + ] + }, + "examples": { + "default": { + "value": { + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -98115,24 +99573,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "oidc" } - } - }, - "/organizations/{org}/dependabot/repository-access/default-level": { + }, "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "summary": "Set the customization template for an OIDC subject claim for an organization", + "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -98150,259 +99605,57 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } }, "required": [ - "default_level" + "include_claim_keys" ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", + "default": { "value": { - "default_level": "public" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "include_claim_keys": [ + "repo", + "context" + ] } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/organizations/{org}/settings/billing/usage": { - "get": { - "summary": "Get billing usage report for an organization", - "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform).\"", - "tags": [ - "billing" - ], - "operationId": "billing/get-github-billing-usage-report-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "month", - "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "day", - "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "hour", - "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - } - ], "responses": { - "200": { - "description": "Billing usage report response for an organization", + "201": { + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "usageItems": [ - { - "date": "2023-08-01", - "product": "Actions", - "sku": "Actions Linux", - "quantity": 100, - "unitType": "minutes", - "pricePerUnit": 0.008, - "grossAmount": 0.8, - "discountAmount": 0, - "netAmount": 0.8, - "organizationName": "GitHub", - "repositoryName": "github/example" - } - ] - } + "value": null } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98424,48 +99677,6 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, @@ -98494,74 +99705,27 @@ } } } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "previews": [], + "category": "actions", + "subcategory": "oidc" } } }, - "/orgs/{org}": { + "/orgs/{org}/actions/permissions": { "get": { - "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -98580,626 +99744,45 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { + "enabled_repositories": { "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", + "enum": [ + "all", + "none", + "selected" ] }, - "members_allowed_repository_creation_type": { + "selected_repositories_url": { "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", - "examples": [ - false - ], - "deprecated": true + "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`." }, - "created_at": { + "allowed_actions": { "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] }, - "updated_at": { + "selected_actions_url": { "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "enabled_repositories" ] }, "examples": { - "default-response": { + "default": { "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "archived_at": null, - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false, - "secret_scanning_validity_checks_enabled": false - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } } } @@ -99208,22 +99791,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" } }, - "patch": { - "summary": "Update an organization", - "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -99236,895 +99819,145 @@ } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "billing_email": { - "type": "string", - "description": "Billing email address. This address is not publicized." - }, - "company": { - "type": "string", - "description": "The company name." - }, - "email": { - "type": "string", - "description": "The publicly visible email address." - }, - "twitter_username": { - "type": "string", - "description": "The Twitter username of the company." - }, - "location": { - "type": "string", - "description": "The location." - }, - "name": { - "type": "string", - "description": "The shorthand name of the company." - }, - "description": { - "type": "string", - "description": "The description of the company. The maximum size is 160 characters." - }, - "has_organization_projects": { - "type": "boolean", - "description": "Whether an organization can use organization projects." - }, - "has_repository_projects": { - "type": "boolean", - "description": "Whether repositories that belong to the organization can use repository projects." - }, - "default_repository_permission": { - "type": "string", - "description": "Default permission level members have for organization repositories.", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read" - }, - "members_can_create_repositories": { - "type": "boolean", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "default": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_private_repositories": { - "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_public_repositories": { - "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_allowed_repository_creation_type": { + "enabled_repositories": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ "all", - "private", - "none" + "none", + "selected" ] }, - "members_can_create_pages": { - "type": "boolean", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Whether organization members can fork private organization repositories.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", - "default": false - }, - "blog": { + "allowed_actions": { "type": "string", - "examples": [ - "\"http://github.blog\"" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": "string", - "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", - "deprecated": true - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } - } + }, + "required": [ + "enabled_repositories" + ] }, "examples": { "default": { "value": { - "billing_email": "mona@github.com", - "company": "GitHub", - "email": "mona@github.com", - "twitter_username": "github", - "location": "San Francisco", - "name": "github", - "description": "GitHub, the company.", - "default_repository_permission": "read", - "members_can_create_repositories": true, - "members_allowed_repository_creation_type": "all" + "enabled_repositories": "all", + "allowed_actions": "selected" } } } } } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Response", "content": { - "application/json": { - "schema": { - "title": "Organization Full", - "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", - "examples": [ - false - ], - "deprecated": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "archived_at": null, - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false, - "secret_scanning_validity_checks_enabled": false + "days": 90, + "maximum_allowed_days": 365 } } } } } }, - "422": { - "description": "Validation failed", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - ] + } } } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100151,22 +99984,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } }, - "delete": { - "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service", - "operationId": "orgs/delete", + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", "tags": [ - "orgs" + "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -100179,17 +100011,57 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" + } + }, + "required": [ + "days" + ] + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, "responses": { - "202": { - "description": "Accepted", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -100221,8 +100093,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -100246,27 +100118,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage": { + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { "get": { - "summary": "Get GitHub Actions cache usage for an organization", - "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -100287,59 +100233,73 @@ "schema": { "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." - }, - "total_active_caches_size_in_bytes": { - "type": "integer", - "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." } }, "required": [ - "total_active_caches_count", - "total_active_caches_size_in_bytes" + "approval_policy" ] }, "examples": { "default": { "value": { - "total_active_caches_size_in_bytes": 3344284, - "total_active_caches_count": 5 + "approval_policy": "first_time_contributors" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/cache/usage-by-repository": { - "get": { - "summary": "List repositories with GitHub Actions cache usage for an organization", - "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -100350,129 +100310,164 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ - "total_count", - "repository_cache_usages" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repository_cache_usages": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", "type": "object", + "required": [ + "code" + ], "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "octo-org/Hello-World" - ] + "resource": { + "type": "string" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "examples": [ - 2322142 - ] + "field": { + "type": "string" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "repository_cache_usages": [ - { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - { - "full_name": "octo-org/server", - "active_caches_size_in_bytes": 1022142, - "active_caches_count": 2 } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners": { + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { "get": { - "summary": "List GitHub-hosted runners for an organization", - "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], - "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -100483,24 +100478,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -100511,311 +100488,112 @@ "schema": { "type": "object", "required": [ - "total_count", - "runners" + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" ], "properties": { - "total_count": { - "type": "integer" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runners": { - "type": "array", - "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - } + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - }, - { - "id": 7, - "name": "My hosted Windows runner", - "runner_group_id": 2, - "platform": "win-x64", - "image": { - "id": "windows-latest", - "size": 256 - }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 - }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" - } - ] + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "post": { - "summary": "Create a GitHub-hosted runner for an organization", - "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/create-hosted-runner-for-org", + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -100834,66 +100612,35 @@ "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "image": { - "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the runner image.", - "type": "string" - }, - "source": { - "description": "The source of the runner image.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - } - }, - "size": { - "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", - "type": "string" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "enable_static_ip": { - "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { "default": { "value": { - "name": "My Hosted runner", - "image": { - "id": "ubuntu-latest", - "source": "github" - }, - "runner_group_id": 1, - "size": "4-core", - "maximum_runners": 50, - "enable_static_ip": false + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } @@ -100901,245 +100648,130 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] + "documentation_url": { + "type": "string" }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] + "documentation_url": { + "type": "string" }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "url": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", + "required": [ + "code" + ], "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] + "resource": { + "type": "string" }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] + "field": { + "type": "string" }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } } } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -101149,23 +100781,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/permissions/repositories": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101176,6 +100807,24 @@ "schema": { "type": "string" } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -101187,180 +100836,961 @@ "type": "object", "required": [ "total_count", - "images" + "repositories" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "images": { + "repositories": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", "examples": [ - "ubuntu-20.04" + 108 ] }, - "platform": { - "description": "The operating system of the image.", + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "linux-x64" + "master" ] }, - "size_gb": { - "description": "Image size in GB.", + "open_issues_count": { "type": "integer", "examples": [ - 86 + 0 ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true ] - } - }, - "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/hosted-runners/images/partner": { - "get": { - "summary": "Get partner images for GitHub-hosted runners in an organization", - "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-partner-images-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "images" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "images": { - "type": "array", - "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", "examples": [ - "ubuntu-20.04" + true ] }, - "platform": { - "description": "The operating system of the image.", - "type": "string", + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", "examples": [ - "linux-x64" + true ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, "examples": [ - 86 + true ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", "enum": [ - "github", - "partner", - "custom" + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "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", - "platform", - "size_gb", - "display_name", - "source" + "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" ] } } @@ -101369,11 +101799,132 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "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, + "allow_auto_merge": false, + "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 + } + ] } } } @@ -101382,24 +101933,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/limits": { - "get": { - "summary": "Get limits on GitHub-hosted runners for an organization", - "description": "Get the GitHub-hosted runners limits for an organization.", - "operationId": "actions/get-hosted-runners-limits-for-org", + }, + "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101413,51 +101962,37 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "public_ips": { - "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", - "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", - "type": "object", - "properties": { - "maximum": { - "type": "integer", - "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" - ] + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "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": [ - "public_ips" - ] + } }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] } } } @@ -101465,24 +102000,24 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/machine-sizes": { - "get": { - "summary": "Get GitHub-hosted runners machine specs for an organization", - "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/enable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101493,102 +102028,39 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "machine_specs" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "machine_specs": { - "type": "array", - "items": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/platforms": { - "get": { - "summary": "Get platforms for GitHub-hosted runners in an organization", - "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-platforms-for-org", + }, + "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/disable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101599,65 +102071,41 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "platforms" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "platforms": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "platforms": [ - "linux-x64", - "win-x64" - ] - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/orgs/{org}/actions/permissions/selected-actions": { "get": { - "summary": "Get a GitHub-hosted runner for an organization", - "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "summary": "Get allowed actions and reusable workflows for an organization", + "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-organization", "tags": [ "actions" ], - "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -101668,15 +102116,6 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -101685,272 +102124,58 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "verified_allowed": { "type": "boolean", - "examples": [ - true - ] + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "patterns_allowed": { "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } + "type": "string" } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { "default": { "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "patch": { - "summary": "Update a GitHub-hosted runner for an organization", - "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/update-hosted-runner-for-org", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -101961,296 +102186,46 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "verified_allowed": { + "type": "boolean", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "enable_static_ip": { - "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", + "items": { + "type": "string" + } } } }, "examples": { - "default": { + "selected_actions": { "value": { - "name": "My larger runner", - "runner_group_id": 1, - "maximum_runners": 50, - "enable_static_ip": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } @@ -102261,19 +102236,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -102284,324 +102261,92 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", + "enabled_repositories": { "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" + "all", + "selected", + "none" ] }, - "platform": { - "description": "The operating system of the image.", + "selected_repositories_url": { "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/oidc/customization/sub": { - "get": { - "summary": "Get the customization template for an OIDC subject claim for an organization", - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "oidc" - ], - "operationId": "oidc/get-oidc-custom-sub-template-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "A JSON serialized template for OIDC subject claim customization", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -102612,19 +102357,19 @@ "x-github": { "enabledForGitHubApps": true, "category": "actions", - "subcategory": "oidc" + "subcategory": "permissions" } }, "put": { - "summary": "Set the customization template for an OIDC subject claim for an organization", - "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", "tags": [ - "oidc" + "actions" ], - "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -102642,29 +102387,26 @@ "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { - "default": { + "application/json": { "value": { - "include_claim_keys": [ - "repo", - "context" - ] + "enabled_repositories": "all" } } } @@ -102672,20 +102414,30 @@ } }, "responses": { - "201": { - "description": "Empty response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -102717,8 +102469,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -102742,84 +102494,76 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } - } - }, - "/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 and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "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`." + "message": { + "type": "string" }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] + "documentation_url": { + "type": "string" }, - "selected_actions_url": { - "type": "string", - "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -102829,98 +102573,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, - "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": true, - "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.", - "enum": [ - "all", - "none", - "selected" - ] - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -102958,13 +102626,9 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "repositories": { "type": "array", @@ -104054,25 +103718,76 @@ } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -104085,37 +103800,32 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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." - } + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "application/json": { "value": { "selected_repository_ids": [ - 32, - 42 + 1, + 2, + 3 ] } } @@ -104123,25 +103833,156 @@ } } }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/enable-selected-repository-github-actions-organization", + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -104165,26 +104006,178 @@ ], "responses": { "204": { - "description": "Response" + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/disable-selected-repository-github-actions-organization", + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -104208,148 +104201,156 @@ ], "responses": { "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/selected-actions": { - "get": { - "summary": "Get allowed actions and reusable workflows for an organization", - "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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." + "message": { + "type": "string" }, - "verified_allowed": { - "type": "boolean", - "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." + "documentation_url": { + "type": "string" }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": false, - "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 from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", - "items": { + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { "type": "string" } } } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } @@ -104358,7 +104359,6 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } @@ -123984,9 +123984,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -137591,6 +137591,14 @@ "type": "string" } }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, { "name": "has", "in": "query", @@ -597420,7 +597428,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -597977,7 +597985,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -598586,7 +598594,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -599121,7 +599129,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -599791,7 +599799,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -600451,7 +600459,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -600831,7 +600839,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -601478,7 +601486,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -602363,7 +602371,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -602991,7 +602999,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -603832,7 +603840,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -604646,7 +604654,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -1178353,6 +1178361,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1178364,6 +1178375,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -1178427,6 +1178441,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1178438,6 +1178455,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index e42e3dc0ce..26edd82639 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -1044,7 +1044,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &209 + schema: &203 title: Validation Error Simple description: Validation Error Simple type: object @@ -1837,7 +1837,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &208 + schema: &202 title: Validation Error description: Validation Error type: object @@ -7670,8 +7670,7 @@ paths: parameters: - &39 name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -7681,7 +7680,7 @@ paths: description: Response content: application/json: - schema: &210 + schema: &204 type: object properties: total_active_caches_count: @@ -7696,7 +7695,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &211 + default: &205 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7901,7 +7900,7 @@ paths: - public_ip_enabled - platform examples: - default: &212 + default: &206 value: total_count: 2 runners: @@ -8191,7 +8190,7 @@ paths: description: Response content: application/json: - schema: &213 + schema: &207 type: object properties: public_ips: @@ -8218,7 +8217,7 @@ paths: required: - public_ips examples: - default: &214 + default: &208 value: public_ips: current_usage: 17 @@ -8258,7 +8257,7 @@ paths: type: array items: *43 examples: - default: &215 + default: &209 value: id: 4-core cpu_cores: 4 @@ -8516,7 +8515,7 @@ paths: - all - local_only - selected - selected_actions_url: &218 + selected_actions_url: &212 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -8589,7 +8588,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &194 + schema: &214 type: object properties: days: @@ -8635,7 +8634,7 @@ paths: required: true content: application/json: - schema: &195 + schema: &215 type: object properties: days: @@ -8684,7 +8683,7 @@ paths: required: - approval_policy examples: - default: &196 + default: &216 value: approval_policy: first_time_contributors '404': *6 @@ -8742,7 +8741,7 @@ paths: description: Response content: application/json: - schema: &197 + schema: &217 type: object required: - run_workflows_from_fork_pull_requests @@ -8796,7 +8795,7 @@ paths: required: true content: application/json: - schema: &198 + schema: &218 type: object required: - run_workflows_from_fork_pull_requests @@ -20975,7 +20974,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *39 - - &200 + - &194 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -20984,7 +20983,7 @@ paths: required: false schema: type: integer - - &201 + - &195 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -20993,7 +20992,7 @@ paths: required: false schema: type: integer - - &202 + - &196 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -21002,7 +21001,7 @@ paths: required: false schema: type: integer - - &203 + - &197 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -21023,7 +21022,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &204 + schema: &198 type: object properties: usageItems: @@ -21076,7 +21075,7 @@ paths: - netAmount - organizationName examples: - default: &205 + default: &199 value: usageItems: - date: '2023-08-01' @@ -27066,555 +27065,6 @@ paths: category: orgs subcategory: custom-roles deprecated: true - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: *194 - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: *195 - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: *48 - examples: - default: *196 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *73 - responses: - '204': - description: Response - '404': *6 - '422': *15 - requestBody: - required: true - content: - application/json: - schema: *48 - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: *197 - examples: - default: *49 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: *198 - examples: - default: *49 - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: *3 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - repositories: - type: array - items: *64 - examples: - default: &220 - 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 - allow_auto_merge: false - 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 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - - &199 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - - *199 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -27896,18 +27346,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *73 - - *200 - - *201 - - *202 - - *203 + - *194 + - *195 + - *196 + - *197 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *204 + schema: *198 examples: - default: *205 + default: *199 '400': *14 '403': *27 '500': *88 @@ -27943,7 +27393,7 @@ paths: description: Response content: application/json: - schema: &206 + schema: &200 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -28353,7 +27803,7 @@ paths: - updated_at - archived_at examples: - default-response: &207 + default-response: &201 value: login: github id: 1 @@ -28679,17 +28129,17 @@ paths: description: Response content: application/json: - schema: *206 + schema: *200 examples: - default: *207 + default: *201 '422': description: Validation failed content: application/json: schema: oneOf: - - *208 - - *209 + - *202 + - *203 '409': *99 x-github: githubCloudOnly: false @@ -28744,9 +28194,9 @@ paths: description: Response content: application/json: - schema: *210 + schema: *204 examples: - default: *211 + default: *205 headers: Link: *38 x-github: @@ -28865,7 +28315,7 @@ paths: type: array items: *40 examples: - default: *212 + default: *206 headers: Link: *38 x-github: @@ -29049,9 +28499,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *207 examples: - default: *214 + default: *208 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29087,7 +28537,7 @@ paths: type: array items: *43 examples: - default: *215 + default: *209 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29270,7 +28720,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &216 + schema: &210 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -29284,7 +28734,7 @@ paths: required: - include_claim_keys examples: - default: &217 + default: &211 value: include_claim_keys: - repo @@ -29311,9 +28761,9 @@ paths: required: true content: application/json: - schema: *216 + schema: *210 examples: - default: *217 + default: *211 responses: '201': description: Empty response @@ -29358,7 +28808,7 @@ paths: schema: type: object properties: - enabled_repositories: &219 + enabled_repositories: &213 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -29372,7 +28822,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *47 - selected_actions_url: *218 + selected_actions_url: *212 required: - enabled_repositories examples: @@ -29412,7 +28862,7 @@ paths: schema: type: object properties: - enabled_repositories: *219 + enabled_repositories: *213 allowed_actions: *47 required: - enabled_repositories @@ -29426,6 +28876,195 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: *214 + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: *215 + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: *48 + examples: + default: *216 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *73 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *48 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: *217 + examples: + default: *49 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: *218 + examples: + default: *49 + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: *3 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -29460,7 +29099,127 @@ paths: type: array items: *64 examples: - default: *220 + default: &220 + 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 + allow_auto_merge: false + 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 @@ -29525,7 +29284,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - *199 + - &219 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -29548,7 +29313,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - *199 + - *219 responses: '204': description: Response @@ -29618,6 +29383,240 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *64 + examples: + default: *220 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + - *219 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + - *219 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -30114,7 +30113,7 @@ paths: type: array items: *40 examples: - default: *212 + default: *206 headers: Link: *38 x-github: @@ -30456,7 +30455,7 @@ paths: parameters: - *73 - *58 - - *199 + - *219 responses: '204': description: Response @@ -30480,7 +30479,7 @@ paths: parameters: - *73 - *58 - - *199 + - *219 responses: '204': description: Response @@ -34172,9 +34171,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -37394,6 +37393,13 @@ paths: - *279 - *280 - *281 + - name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string - *282 - *283 - *284 @@ -54474,8 +54480,8 @@ paths: application/json: schema: oneOf: - - *208 - - *209 + - *202 + - *203 '503': description: Response content: @@ -57389,7 +57395,7 @@ paths: type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *47 - selected_actions_url: *218 + selected_actions_url: *212 required: - enabled examples: @@ -57550,7 +57556,7 @@ paths: description: Response content: application/json: - schema: *194 + schema: *214 examples: default: value: @@ -57585,7 +57591,7 @@ paths: required: true content: application/json: - schema: *195 + schema: *215 examples: default: summary: Set retention days @@ -57618,7 +57624,7 @@ paths: application/json: schema: *48 examples: - default: *196 + default: *216 '404': *6 x-github: enabledForGitHubApps: true @@ -57679,7 +57685,7 @@ paths: description: Response content: application/json: - schema: *197 + schema: *217 examples: default: *49 '403': *27 @@ -57707,7 +57713,7 @@ paths: required: true content: application/json: - schema: *198 + schema: *218 examples: default: *49 responses: @@ -72448,7 +72454,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *208 + schema: *202 '403': *27 x-github: triggersNotification: true @@ -81339,7 +81345,7 @@ paths: application/json: schema: oneOf: - - *208 + - *202 - *575 x-github: githubCloudOnly: false @@ -99976,7 +99982,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *208 + schema: *202 examples: invalid_state_transition: value: @@ -111614,7 +111620,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *199 + - *219 responses: '204': description: Response @@ -111640,7 +111646,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *199 + - *219 responses: '204': description: Response @@ -116983,10 +116989,10 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *247 - - *200 - - *201 - - *202 - - *203 + - *194 + - *195 + - *196 + - *197 responses: '200': description: Response when getting a billing usage report @@ -166592,6 +166598,8 @@ webhooks: type: string title: type: string + title_html: + type: string duration: type: - number @@ -166600,6 +166608,8 @@ webhooks: type: - string - 'null' + completed: + type: boolean required: - id - title diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index eee8a7229e..4609fbd52a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -18658,7 +18658,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -18731,7 +18731,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19074,7 +19074,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19425,7 +19425,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19542,7 +19542,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19659,7 +19659,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19742,7 +19742,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19848,7 +19848,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -19917,7 +19917,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20210,7 +20210,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20533,7 +20533,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20820,7 +20820,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20882,7 +20882,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -20963,7 +20963,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21040,7 +21040,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21133,7 +21133,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21297,7 +21297,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21385,7 +21385,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21554,7 +21554,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21655,7 +21655,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -21833,7 +21833,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22026,7 +22026,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22095,7 +22095,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22138,7 +22138,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22183,7 +22183,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22253,7 +22253,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22328,7 +22328,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22411,7 +22411,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22575,7 +22575,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22643,7 +22643,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22712,7 +22712,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -22901,7 +22901,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23107,7 +23107,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23236,7 +23236,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23426,7 +23426,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23471,7 +23471,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23673,7 +23673,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23751,7 +23751,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23803,7 +23803,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -23857,7 +23857,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24094,7 +24094,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24172,7 +24172,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24224,7 +24224,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24286,7 +24286,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24512,7 +24512,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24623,7 +24623,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -24933,7 +24933,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -25986,7 +25986,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27039,7 +27039,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27205,7 +27205,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27280,7 +27280,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27423,7 +27423,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27630,7 +27630,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -27837,7 +27837,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28007,7 +28007,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28191,7 +28191,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28342,7 +28342,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28434,7 +28434,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28470,7 +28470,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28575,7 +28575,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -28694,7 +28694,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -29246,7 +29246,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -31428,7 +31428,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -31539,7 +31539,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -31670,7 +31670,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -32811,7 +32811,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -32959,7 +32959,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33148,7 +33148,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33462,7 +33462,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33527,7 +33527,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -33625,7 +33625,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34021,7 +34021,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34123,7 +34123,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34544,7 +34544,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34595,7 +34595,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35065,7 +35065,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36714,7 +36714,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37174,7 +37174,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37901,7 +37901,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -38319,7 +38319,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -38729,7 +38729,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39388,7 +39388,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39579,7 +39579,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39746,7 +39746,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40212,7 +40212,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41006,7 +41006,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41157,7 +41157,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41284,7 +41284,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41535,7 +41535,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -42442,7 +42442,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -43098,7 +43098,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -45094,7 +45094,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -45195,7 +45195,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46089,7 +46089,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46254,7 +46254,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46413,7 +46413,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46539,7 +46539,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46701,7 +46701,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46747,7 +46747,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46863,7 +46863,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47090,7 +47090,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47470,7 +47470,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47698,7 +47698,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -47915,7 +47915,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -48233,7 +48233,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -48330,7 +48330,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -51048,7 +51048,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -52434,7 +52434,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55154,7 +55154,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55251,7 +55251,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55435,7 +55435,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -55632,7 +55632,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -57697,7 +57697,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -57994,7 +57994,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58354,7 +58354,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58496,7 +58496,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58693,7 +58693,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -58968,7 +58968,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -59141,7 +59141,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -59742,7 +59742,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -59998,7 +59998,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60270,7 +60270,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60518,7 +60518,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60589,7 +60589,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60660,7 +60660,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -60976,7 +60976,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -61641,7 +61641,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -94163,17 +94163,17 @@ "deprecated": true } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { + "/organizations/{org}/dependabot/repository-access": { "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -94184,6 +94184,29 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } } ], "responses": { @@ -94192,28 +94215,666 @@ "content": { "application/json": { "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days artifacts and logs are retained" + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] }, - "maximum_allowed_days": { - "type": "integer", - "description": "The maximum number of days that can be configured" + "accessible_repositories": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + ] + } } }, - "required": [ - "days", - "maximum_allowed_days" - ] + "additionalProperties": false }, "examples": { - "response": { - "summary": "Example response", + "default": { "value": { - "days": 90, - "maximum_allowed_days": 365 + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "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, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] } } } @@ -94274,21 +94935,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/update-repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -94308,19 +94970,50 @@ "schema": { "type": "object", "properties": { - "days": { - "type": "integer", - "description": "The number of days to retain artifacts and logs" + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." } }, - "required": [ - "days" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "application/json": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "days": 100 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] } } } @@ -94329,7 +95022,7 @@ }, "responses": { "204": { - "description": "No content" + "description": "Response" }, "403": { "description": "Forbidden", @@ -94382,214 +95075,27 @@ } } } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "approval_policy": { - "type": "string", - "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" - ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." - } - }, - "required": [ - "approval_policy" - ] - }, - "examples": { - "default": { - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, + "/organizations/{org}/dependabot/repository-access/default-level": { "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -94602,112 +95108,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, "requestBody": { "required": true, "content": { @@ -94715,105 +95115,36 @@ "schema": { "type": "object", "properties": { - "approval_policy": { + "default_level": { "type": "string", + "description": "The default repository access level for Dependabot updates.", "enum": [ - "first_time_contributors_new_to_github", - "first_time_contributors", - "all_external_contributors" + "public", + "internal" ], - "description": "The policy that controls when fork PR workflows require approval from a maintainer." + "examples": [ + "internal" + ] } }, "required": [ - "approval_policy" + "default_level" ] }, "examples": { - "default": { - "summary": "Set approval policy to first time contributors", + "204": { + "summary": "Example with a 'succeeded' status.", "value": { - "approval_policy": "first_time_contributors" + "default_level": "public" } } } } } }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { - "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests", - "send_write_tokens_to_workflows", - "send_secrets_and_variables", - "require_approval_for_fork_pr_workflows" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "examples": { - "default": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - } - } - } - } + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -94869,21 +95200,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + } + }, + "/organizations/{org}/settings/billing/usage": { + "get": { + "summary": "Get billing usage report for an organization", + "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform).\"", "tags": [ - "actions" + "billing" ], + "operationId": "billing/get-github-billing-usage-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -94894,251 +95228,144 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "run_workflows_from_fork_pull_requests" - ], - "properties": { - "run_workflows_from_fork_pull_requests": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." - }, - "send_write_tokens_to_workflows": { - "type": "boolean", - "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." - }, - "send_secrets_and_variables": { - "type": "boolean", - "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." - }, - "require_approval_for_fork_pr_workflows": { - "type": "boolean", - "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." - } - } - }, - "examples": { - "default": { - "value": { - "run_workflows_from_fork_pull_requests": true, - "send_write_tokens_to_workflows": false, - "send_secrets_and_variables": false, - "require_approval_for_fork_pr_workflows": true - } - } - } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" }, - "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" } }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } + { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { + "usageItems": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" + "date": { + "type": "string", + "description": "Date of the usage line item." }, - "field": { - "type": "string" + "product": { + "type": "string", + "description": "Product name." }, - "message": { - "type": "string" + "sku": { + "type": "string", + "description": "SKU name." }, - "code": { - "type": "string" + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." }, - "index": { - "type": "integer" + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." } - } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] } } } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { - "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" - } - } }, "examples": { - "response": { - "summary": "Example response", + "default": { "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] } } } } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -95160,98 +95387,50 @@ } } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", "properties": { "message": { - "type": "string" + "type": [ + "string", + "null" + ] }, "documentation_url": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "detail": { + "type": [ + "string", + "null" + ] }, "status": { - "type": "string" + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", - "enum": [ - "all", - "selected", - "none" - ] - } - } - }, - "examples": { - "application/json": { - "value": { - "enabled_repositories": "all" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" }, "403": { "description": "Forbidden", @@ -95279,8 +95458,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -95305,101 +95484,21 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { + "code": { "type": "string" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } } } } @@ -95408,23 +95507,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { + "/orgs/{org}": { "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "summary": "Get an organization", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", "tags": [ - "actions" + "orgs" ], + "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -95435,24 +95535,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -95461,1146 +95543,2800 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", "type": "object", "properties": { - "total_count": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "repositories": { - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "examples": [ + false + ], + "deprecated": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default-response": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "archived_at": null, + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false, + "secret_scanning_validity_checks_enabled": false + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "patch": { + "summary": "Update an organization", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billing_email": { + "type": "string", + "description": "Billing email address. This address is not publicized." + }, + "company": { + "type": "string", + "description": "The company name." + }, + "email": { + "type": "string", + "description": "The publicly visible email address." + }, + "twitter_username": { + "type": "string", + "description": "The Twitter username of the company." + }, + "location": { + "type": "string", + "description": "The location." + }, + "name": { + "type": "string", + "description": "The shorthand name of the company." + }, + "description": { + "type": "string", + "description": "The description of the company. The maximum size is 160 characters." + }, + "has_organization_projects": { + "type": "boolean", + "description": "Whether an organization can use organization projects." + }, + "has_repository_projects": { + "type": "boolean", + "description": "Whether repositories that belong to the organization can use repository projects." + }, + "default_repository_permission": { + "type": "string", + "description": "Default permission level members have for organization repositories.", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read" + }, + "members_can_create_repositories": { + "type": "boolean", + "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "default": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_private_repositories": { + "type": "boolean", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_public_repositories": { + "type": "boolean", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_allowed_repository_creation_type": { + "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "enum": [ + "all", + "private", + "none" + ] + }, + "members_can_create_pages": { + "type": "boolean", + "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "description": "Whether organization members can fork private organization repositories.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", + "default": false + }, + "blog": { + "type": "string", + "examples": [ + "\"http://github.blog\"" + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "deprecated": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + } + } + }, + "examples": { + "default": { + "value": { + "billing_email": "mona@github.com", + "company": "GitHub", + "email": "mona@github.com", + "twitter_username": "github", + "location": "San Francisco", + "name": "github", + "description": "GitHub, the company.", + "default_repository_permission": "read", + "members_can_create_repositories": true, + "members_allowed_repository_creation_type": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Full", + "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" + ], + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "examples": [ + false + ], + "deprecated": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "archived_at": null, + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false, + "secret_scanning_validity_checks_enabled": false + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Delete an organization", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service", + "operationId": "orgs/delete", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for an organization", + "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." + }, + "total_active_caches_size_in_bytes": { + "type": "integer", + "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + } + }, + "required": [ + "total_active_caches_count", + "total_active_caches_size_in_bytes" + ] + }, + "examples": { + "default": { + "value": { + "total_active_caches_size_in_bytes": 3344284, + "total_active_caches_count": 5 + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/cache/usage-by-repository": { + "get": { + "summary": "List repositories with GitHub Actions cache usage for an organization", + "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-by-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repository_cache_usages" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repository_cache_usages": { + "type": "array", + "items": { + "title": "Actions Cache Usage by repository", + "description": "GitHub Actions Cache Usage by repository.", + "type": "object", + "properties": { + "full_name": { + "description": "The repository owner and name for the cache usage being shown.", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "octo-org/Hello-World" ] }, - "subscription_url": { - "type": "string", - "format": "uri", + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + 2322142 ] }, - "tags_url": { - "type": "string", - "format": "uri", + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + 3 ] - }, - "teams_url": { - "type": "string", - "format": "uri", + } + }, + "required": [ + "full_name", + "active_caches_size_in_bytes", + "active_caches_count" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "repository_cache_usages": [ + { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + }, + { + "full_name": "octo-org/server", + "active_caches_size_in_bytes": 1022142, + "active_caches_count": 2 + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners for an organization", + "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-hosted-runners-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + 5 ] }, - "trees_url": { + "name": { + "description": "The name of the hosted runner.", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "my-github-hosted-runner" ] }, - "clone_url": { - "type": "string", + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", "examples": [ - "https://github.com/octocat/Hello-World.git" + 2 ] }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:06:43Z" + "2022-10-09T23:39:01Z" ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + }, + { + "id": 7, + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 }, - "temp_clone_token": { - "type": "string" + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "post": { + "summary": "Create a GitHub-hosted runner for an organization", + "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/create-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "image": { + "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the runner image.", + "type": "string" + }, + "source": { + "description": "The source of the runner image.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + } + }, + "size": { + "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" + } + }, + "required": [ + "name", + "image", + "size", + "runner_group_id" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Hosted runner", + "image": { + "id": "ubuntu-latest", + "source": "github" + }, + "runner_group_id": 1, + "size": "4-core", + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", "type": "boolean", "examples": [ true ] }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "20.80.208.150" ] }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", + "length": { + "description": "The length of the IP prefix.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:42Z\"" + 28 ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } - }, - "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" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ { - "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 + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] }, - "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 + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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" + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ] + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } } } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" } } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "images" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" } } } @@ -96609,21 +98345,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + } + }, + "/orgs/{org}/actions/hosted-runners/limits": { + "get": { + "summary": "Get limits on GitHub-hosted runners for an organization", + "description": "Get the GitHub-hosted runners limits for an organization.", + "operationId": "actions/get-hosted-runners-limits-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -96636,189 +98375,183 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "selected_repository_ids" - ], - "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" - } - } - }, - "examples": { - "application/json": { - "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] - } - } - } - } - } - }, "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 17 + ] + } + }, + "required": [ + "maximum", + "current_usage" + ] } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } } } } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + "get": { + "summary": "Get GitHub-hosted runners machine specs for an organization", + "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "machine_specs" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "machine_specs": { "type": "array", "items": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] }, - "code": { - "type": "string" + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] }, - "index": { - "type": "integer" + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 ] } - } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] } } } + }, + "examples": { + "default": { + "value": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + } + } } } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "/orgs/{org}/actions/hosted-runners/platforms": { + "get": { + "summary": "Get platforms for GitHub-hosted runners in an organization", + "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-platforms-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -96829,191 +98562,358 @@ "schema": { "type": "string" } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "platforms" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "platforms": { + "type": "array", + "items": { + "type": "string" + } } } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "get": { + "summary": "Get a GitHub-hosted runner for an organization", + "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "409": { - "description": "Conflict", + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "documentation_url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "errors": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "patch": { + "summary": "Update a GitHub-hosted runner for an organization", + "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/update-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97026,8 +98926,8 @@ } }, { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -97035,157 +98935,284 @@ } } ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" } } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false } } } } - }, - "409": { - "description": "Conflict", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "documentation_url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "errors": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] }, - "index": { - "type": "integer" + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 ] } } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -97195,22 +99222,21 @@ }, "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - } - }, - "/organizations/{org}/dependabot/repository-access": { - "get": { - "summary": "Lists the repositories Dependabot can access in an organization", - "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", "tags": [ - "dependabot" + "actions" ], - "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97223,747 +99249,255 @@ } }, { - "name": "page", - "in": "query", - "description": "The page number of results to fetch.", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "default": 1 - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of results per page.", - "required": false, + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Dependabot Repository Access Details", - "description": "Information about repositories that Dependabot is able to access in an organization", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "default_level": { - "type": [ - "string", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", "examples": [ - "internal" + 5 ] }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "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" - ] - } - ] - } - } - }, - "additionalProperties": false - }, - "examples": { - "default": { - "value": { - "default_level": "public", - "accessible_repositories": [ + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ { - "id": 123456, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", - "name": "example-repo", - "full_name": "octocat/example-repo", - "owner": { - "name": "octocat", - "email": "octo@github.com", - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", - "gravatar_id": 1, - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat/example-repo", - "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, - "starred_at": "\"2020-07-09T00:17:55Z\"", - "user_view_type": "default" + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } }, - "private": false, - "html_url": "https://github.com/octocat/example-repo", - "description": "This is an example repository.", - "fork": false, - "url": "https://api.github.com/repos/octocat/example-repo", - "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", - "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", - "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", - "events_url": "https://api.github.com/repos/octocat/example-repo/events", - "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", - "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", - "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", - "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", - "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", - "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", - "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "url": { - "type": "string" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] }, - "documentation_url": { - "type": "string" + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] }, - "url": { - "type": "string" + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } }, - "status": { - "type": "string" + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -97973,21 +99507,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" } - }, - "patch": { - "summary": "Updates Dependabot's repository access list for an organization", - "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + } + }, + "/orgs/{org}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for an organization", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/update-repository-access-for-org", + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -98000,113 +99536,35 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_ids_to_add": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to add." - }, - "repository_ids_to_remove": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of repository IDs to remove." - } - }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status." - }, - "add-example": { - "summary": "Add repositories", - "value": { - "repository_ids_to_add": [ - 123, - 456 - ] - } - }, - "remove-example": { - "summary": "Remove repositories", - "value": { - "repository_ids_to_remove": [ - 789 - ] - } - } - } - } - } - }, "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "required": [ + "include_claim_keys" + ] + }, + "examples": { + "default": { + "value": { + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -98115,24 +99573,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "oidc" } - } - }, - "/organizations/{org}/dependabot/repository-access/default-level": { + }, "put": { - "summary": "Set the default repository access level for Dependabot", - "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "summary": "Set the customization template for an OIDC subject claim for an organization", + "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "dependabot" + "oidc" ], - "operationId": "dependabot/set-repository-access-default-level", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -98150,259 +99605,57 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } } }, "required": [ - "default_level" + "include_claim_keys" ] }, "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", + "default": { "value": { - "default_level": "public" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "include_claim_keys": [ + "repo", + "context" + ] } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/organizations/{org}/settings/billing/usage": { - "get": { - "summary": "Get billing usage report for an organization", - "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform).\"", - "tags": [ - "billing" - ], - "operationId": "billing/get-github-billing-usage-report-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "month", - "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "day", - "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "hour", - "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - } - ], "responses": { - "200": { - "description": "Billing usage report response for an organization", + "201": { + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "usageItems": [ - { - "date": "2023-08-01", - "product": "Actions", - "sku": "Actions Linux", - "quantity": 100, - "unitType": "minutes", - "pricePerUnit": 0.008, - "grossAmount": 0.8, - "discountAmount": 0, - "netAmount": 0.8, - "organizationName": "GitHub", - "repositoryName": "github/example" - } - ] - } + "value": null } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -98424,48 +99677,6 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, @@ -98494,74 +99705,27 @@ } } } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "previews": [], + "category": "actions", + "subcategory": "oidc" } } }, - "/orgs/{org}": { + "/orgs/{org}/actions/permissions": { "get": { - "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -98580,626 +99744,45 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { + "enabled_repositories": { "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", + "enum": [ + "all", + "none", + "selected" ] }, - "members_allowed_repository_creation_type": { + "selected_repositories_url": { "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", - "examples": [ - false - ], - "deprecated": true + "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`." }, - "created_at": { + "allowed_actions": { "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] }, - "updated_at": { + "selected_actions_url": { "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." } }, "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "enabled_repositories" ] }, "examples": { - "default-response": { + "default": { "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "archived_at": null, - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false, - "secret_scanning_validity_checks_enabled": false - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } } } @@ -99208,22 +99791,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" } }, - "patch": { - "summary": "Update an organization", - "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -99236,895 +99819,145 @@ } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "billing_email": { - "type": "string", - "description": "Billing email address. This address is not publicized." - }, - "company": { - "type": "string", - "description": "The company name." - }, - "email": { - "type": "string", - "description": "The publicly visible email address." - }, - "twitter_username": { - "type": "string", - "description": "The Twitter username of the company." - }, - "location": { - "type": "string", - "description": "The location." - }, - "name": { - "type": "string", - "description": "The shorthand name of the company." - }, - "description": { - "type": "string", - "description": "The description of the company. The maximum size is 160 characters." - }, - "has_organization_projects": { - "type": "boolean", - "description": "Whether an organization can use organization projects." - }, - "has_repository_projects": { - "type": "boolean", - "description": "Whether repositories that belong to the organization can use repository projects." - }, - "default_repository_permission": { - "type": "string", - "description": "Default permission level members have for organization repositories.", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read" - }, - "members_can_create_repositories": { - "type": "boolean", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "default": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_private_repositories": { - "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_public_repositories": { - "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_allowed_repository_creation_type": { + "enabled_repositories": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ "all", - "private", - "none" + "none", + "selected" ] }, - "members_can_create_pages": { - "type": "boolean", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Whether organization members can fork private organization repositories.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", - "default": false - }, - "blog": { + "allowed_actions": { "type": "string", - "examples": [ - "\"http://github.blog\"" + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": "string", - "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", - "deprecated": true - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } - } + }, + "required": [ + "enabled_repositories" + ] }, "examples": { "default": { "value": { - "billing_email": "mona@github.com", - "company": "GitHub", - "email": "mona@github.com", - "twitter_username": "github", - "location": "San Francisco", - "name": "github", - "description": "GitHub, the company.", - "default_repository_permission": "read", - "members_can_create_repositories": true, - "members_allowed_repository_creation_type": "all" + "enabled_repositories": "all", + "allowed_actions": "selected" } } } } } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Response", "content": { - "application/json": { - "schema": { - "title": "Organization Full", - "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", - "examples": [ - false - ], - "deprecated": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "archived_at": null, - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false, - "secret_scanning_validity_checks_enabled": false + "days": 90, + "maximum_allowed_days": 365 } } } } } }, - "422": { - "description": "Validation failed", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - ] + } } } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100151,22 +99984,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } }, - "delete": { - "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service", - "operationId": "orgs/delete", + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", "tags": [ - "orgs" + "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -100179,17 +100011,57 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" + } + }, + "required": [ + "days" + ] + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, "responses": { - "202": { - "description": "Accepted", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -100221,8 +100093,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -100246,27 +100118,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage": { + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { "get": { - "summary": "Get GitHub Actions cache usage for an organization", - "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -100287,59 +100233,73 @@ "schema": { "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." - }, - "total_active_caches_size_in_bytes": { - "type": "integer", - "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." } }, "required": [ - "total_active_caches_count", - "total_active_caches_size_in_bytes" + "approval_policy" ] }, "examples": { "default": { "value": { - "total_active_caches_size_in_bytes": 3344284, - "total_active_caches_count": 5 + "approval_policy": "first_time_contributors" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/cache/usage-by-repository": { - "get": { - "summary": "List repositories with GitHub Actions cache usage for an organization", - "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], - "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -100350,129 +100310,164 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ - "total_count", - "repository_cache_usages" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repository_cache_usages": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", "type": "object", + "required": [ + "code" + ], "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "octo-org/Hello-World" - ] + "resource": { + "type": "string" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "examples": [ - 2322142 - ] + "field": { + "type": "string" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "repository_cache_usages": [ - { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - { - "full_name": "octo-org/server", - "active_caches_size_in_bytes": 1022142, - "active_caches_count": 2 } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners": { + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { "get": { - "summary": "List GitHub-hosted runners for an organization", - "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], - "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -100483,24 +100478,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -100511,311 +100488,112 @@ "schema": { "type": "object", "required": [ - "total_count", - "runners" + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" ], "properties": { - "total_count": { - "type": "integer" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runners": { - "type": "array", - "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - } + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - }, - { - "id": 7, - "name": "My hosted Windows runner", - "runner_group_id": 2, - "platform": "win-x64", - "image": { - "id": "windows-latest", - "size": 256 - }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 - }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" - } - ] + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "post": { - "summary": "Create a GitHub-hosted runner for an organization", - "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/create-hosted-runner-for-org", + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -100834,66 +100612,35 @@ "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "image": { - "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the runner image.", - "type": "string" - }, - "source": { - "description": "The source of the runner image.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - } - }, - "size": { - "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", - "type": "string" + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "enable_static_ip": { - "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { "default": { "value": { - "name": "My Hosted runner", - "image": { - "id": "ubuntu-latest", - "source": "github" - }, - "runner_group_id": 1, - "size": "4-core", - "maximum_runners": 50, - "enable_static_ip": false + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true } } } @@ -100901,245 +100648,130 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] + "documentation_url": { + "type": "string" }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] + "documentation_url": { + "type": "string" }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "url": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", + "required": [ + "code" + ], "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] + "resource": { + "type": "string" }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] + "field": { + "type": "string" }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } } } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -101149,23 +100781,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/permissions/repositories": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101176,6 +100807,24 @@ "schema": { "type": "string" } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -101187,180 +100836,961 @@ "type": "object", "required": [ "total_count", - "images" + "repositories" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "images": { + "repositories": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", "examples": [ - "ubuntu-20.04" + 108 ] }, - "platform": { - "description": "The operating system of the image.", + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "linux-x64" + "master" ] }, - "size_gb": { - "description": "Image size in GB.", + "open_issues_count": { "type": "integer", "examples": [ - 86 + 0 ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true ] - } - }, - "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/hosted-runners/images/partner": { - "get": { - "summary": "Get partner images for GitHub-hosted runners in an organization", - "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-partner-images-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "images" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "images": { - "type": "array", - "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", "examples": [ - "ubuntu-20.04" + true ] }, - "platform": { - "description": "The operating system of the image.", - "type": "string", + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", "examples": [ - "linux-x64" + true ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, "examples": [ - 86 + true ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", "examples": [ - 20.04 + true ] }, - "source": { - "description": "The image provider.", + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", "enum": [ - "github", - "partner", - "custom" + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "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", - "platform", - "size_gb", - "display_name", - "source" + "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" ] } } @@ -101369,11 +101799,132 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "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, + "allow_auto_merge": false, + "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 + } + ] } } } @@ -101382,24 +101933,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/limits": { - "get": { - "summary": "Get limits on GitHub-hosted runners for an organization", - "description": "Get the GitHub-hosted runners limits for an organization.", - "operationId": "actions/get-hosted-runners-limits-for-org", + }, + "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101413,51 +101962,37 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "public_ips": { - "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", - "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", - "type": "object", - "properties": { - "maximum": { - "type": "integer", - "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" - ] + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "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": [ - "public_ips" - ] + } }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] } } } @@ -101465,24 +102000,24 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/machine-sizes": { - "get": { - "summary": "Get GitHub-hosted runners machine specs for an organization", - "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/enable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101493,102 +102028,39 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "machine_specs" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "machine_specs": { - "type": "array", - "items": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/hosted-runners/platforms": { - "get": { - "summary": "Get platforms for GitHub-hosted runners in an organization", - "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-platforms-for-org", + }, + "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/disable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -101599,65 +102071,41 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "platforms" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "platforms": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "platforms": [ - "linux-x64", - "win-x64" - ] - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/orgs/{org}/actions/permissions/selected-actions": { "get": { - "summary": "Get a GitHub-hosted runner for an organization", - "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "summary": "Get allowed actions and reusable workflows for an organization", + "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-organization", "tags": [ "actions" ], - "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -101668,15 +102116,6 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -101685,272 +102124,58 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "verified_allowed": { "type": "boolean", - "examples": [ - true - ] + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "patterns_allowed": { "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } + "type": "string" } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { "default": { "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } }, - "patch": { - "summary": "Update a GitHub-hosted runner for an organization", - "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", - "operationId": "actions/update-hosted-runner-for-org", + "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -101961,296 +102186,46 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "responses": { + "204": { + "description": "Response" + } + }, "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "name": { - "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "maximum_runners": { - "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", - "type": "integer" + "verified_allowed": { + "type": "boolean", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "enable_static_ip": { - "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", - "type": "boolean" + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", + "items": { + "type": "string" + } } } }, "examples": { - "default": { + "selected_actions": { "value": { - "name": "My larger runner", - "runner_group_id": 1, - "maximum_runners": 50, - "enable_static_ip": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } @@ -102261,19 +102236,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "hosted-runners" + "subcategory": "permissions" } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -102284,324 +102261,92 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", + "enabled_repositories": { "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" + "all", + "selected", + "none" ] }, - "platform": { - "description": "The operating system of the image.", + "selected_repositories_url": { "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] + } }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/orgs/{org}/actions/oidc/customization/sub": { - "get": { - "summary": "Get the customization template for an OIDC subject claim for an organization", - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "oidc" - ], - "operationId": "oidc/get-oidc-custom-sub-template-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "A JSON serialized template for OIDC subject claim customization", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -102612,19 +102357,19 @@ "x-github": { "enabledForGitHubApps": true, "category": "actions", - "subcategory": "oidc" + "subcategory": "permissions" } }, "put": { - "summary": "Set the customization template for an OIDC subject claim for an organization", - "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", "tags": [ - "oidc" + "actions" ], - "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -102642,29 +102387,26 @@ "content": { "application/json": { "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { - "default": { + "application/json": { "value": { - "include_claim_keys": [ - "repo", - "context" - ] + "enabled_repositories": "all" } } } @@ -102672,20 +102414,30 @@ } }, "responses": { - "201": { - "description": "Empty response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } @@ -102717,8 +102469,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -102742,84 +102494,76 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } - } - }, - "/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 and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "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`." + "message": { + "type": "string" }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] + "documentation_url": { + "type": "string" }, - "selected_actions_url": { - "type": "string", - "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -102829,98 +102573,22 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, - "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-github-actions-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": true, - "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.", - "enum": [ - "all", - "none", - "selected" - ] - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - } - }, - "required": [ - "enabled_repositories" - ] - }, - "examples": { - "default": { - "value": { - "enabled_repositories": "all", - "allowed_actions": "selected" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -102958,13 +102626,9 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "repositories": { "type": "array", @@ -104054,25 +103718,76 @@ } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -104085,37 +103800,32 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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." - } + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "selected_repository_ids" - ] + } }, "examples": { - "default": { + "application/json": { "value": { "selected_repository_ids": [ - 32, - 42 + 1, + 2, + 3 ] } } @@ -104123,25 +103833,156 @@ } } }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } } }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "/orgs/{org}/actions/permissions/self-hosted-runners/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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/enable-selected-repository-github-actions-organization", + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -104165,26 +104006,178 @@ ], "responses": { "204": { - "description": "Response" + "description": "No content" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/disable-selected-repository-github-actions-organization", + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -104208,148 +104201,156 @@ ], "responses": { "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/selected-actions": { - "get": { - "summary": "Get allowed actions and reusable workflows for an organization", - "description": "Gets the selected actions and reusable workflows 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\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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." + "message": { + "type": "string" }, - "verified_allowed": { - "type": "boolean", - "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." + "documentation_url": { + "type": "string" }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "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\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-allowed-actions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "requestBody": { - "required": false, - "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 from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." - }, - "patterns_allowed": { - "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", - "items": { + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { "type": "string" } } } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } @@ -104358,7 +104359,6 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" } @@ -123984,9 +123984,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -137591,6 +137591,14 @@ "type": "string" } }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, { "name": "has", "in": "query", @@ -597420,7 +597428,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -597977,7 +597985,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -598586,7 +598594,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -599121,7 +599129,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -599791,7 +599799,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -600451,7 +600459,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -600831,7 +600839,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -601478,7 +601486,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -602363,7 +602371,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -602991,7 +602999,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -603832,7 +603840,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -604646,7 +604654,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -1178353,6 +1178361,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1178364,6 +1178375,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -1178427,6 +1178441,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -1178438,6 +1178455,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index e42e3dc0ce..26edd82639 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -1044,7 +1044,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &209 + schema: &203 title: Validation Error Simple description: Validation Error Simple type: object @@ -1837,7 +1837,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &208 + schema: &202 title: Validation Error description: Validation Error type: object @@ -7670,8 +7670,7 @@ paths: parameters: - &39 name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -7681,7 +7680,7 @@ paths: description: Response content: application/json: - schema: &210 + schema: &204 type: object properties: total_active_caches_count: @@ -7696,7 +7695,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &211 + default: &205 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7901,7 +7900,7 @@ paths: - public_ip_enabled - platform examples: - default: &212 + default: &206 value: total_count: 2 runners: @@ -8191,7 +8190,7 @@ paths: description: Response content: application/json: - schema: &213 + schema: &207 type: object properties: public_ips: @@ -8218,7 +8217,7 @@ paths: required: - public_ips examples: - default: &214 + default: &208 value: public_ips: current_usage: 17 @@ -8258,7 +8257,7 @@ paths: type: array items: *43 examples: - default: &215 + default: &209 value: id: 4-core cpu_cores: 4 @@ -8516,7 +8515,7 @@ paths: - all - local_only - selected - selected_actions_url: &218 + selected_actions_url: &212 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -8589,7 +8588,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &194 + schema: &214 type: object properties: days: @@ -8635,7 +8634,7 @@ paths: required: true content: application/json: - schema: &195 + schema: &215 type: object properties: days: @@ -8684,7 +8683,7 @@ paths: required: - approval_policy examples: - default: &196 + default: &216 value: approval_policy: first_time_contributors '404': *6 @@ -8742,7 +8741,7 @@ paths: description: Response content: application/json: - schema: &197 + schema: &217 type: object required: - run_workflows_from_fork_pull_requests @@ -8796,7 +8795,7 @@ paths: required: true content: application/json: - schema: &198 + schema: &218 type: object required: - run_workflows_from_fork_pull_requests @@ -20975,7 +20974,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *39 - - &200 + - &194 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -20984,7 +20983,7 @@ paths: required: false schema: type: integer - - &201 + - &195 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -20993,7 +20992,7 @@ paths: required: false schema: type: integer - - &202 + - &196 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -21002,7 +21001,7 @@ paths: required: false schema: type: integer - - &203 + - &197 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -21023,7 +21022,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &204 + schema: &198 type: object properties: usageItems: @@ -21076,7 +21075,7 @@ paths: - netAmount - organizationName examples: - default: &205 + default: &199 value: usageItems: - date: '2023-08-01' @@ -27066,555 +27065,6 @@ paths: category: orgs subcategory: custom-roles deprecated: true - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: *194 - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: *195 - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: *48 - examples: - default: *196 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *73 - responses: - '204': - description: Response - '404': *6 - '422': *15 - requestBody: - required: true - content: - application/json: - schema: *48 - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: *197 - examples: - default: *49 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: *198 - examples: - default: *49 - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: *3 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - *73 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - repositories: - type: array - items: *64 - examples: - default: &220 - 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 - allow_auto_merge: false - 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 - '403': *27 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - - &199 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *73 - - *199 - responses: - '204': - description: No content - '403': *27 - '404': *6 - '409': *99 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -27896,18 +27346,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *73 - - *200 - - *201 - - *202 - - *203 + - *194 + - *195 + - *196 + - *197 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *204 + schema: *198 examples: - default: *205 + default: *199 '400': *14 '403': *27 '500': *88 @@ -27943,7 +27393,7 @@ paths: description: Response content: application/json: - schema: &206 + schema: &200 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -28353,7 +27803,7 @@ paths: - updated_at - archived_at examples: - default-response: &207 + default-response: &201 value: login: github id: 1 @@ -28679,17 +28129,17 @@ paths: description: Response content: application/json: - schema: *206 + schema: *200 examples: - default: *207 + default: *201 '422': description: Validation failed content: application/json: schema: oneOf: - - *208 - - *209 + - *202 + - *203 '409': *99 x-github: githubCloudOnly: false @@ -28744,9 +28194,9 @@ paths: description: Response content: application/json: - schema: *210 + schema: *204 examples: - default: *211 + default: *205 headers: Link: *38 x-github: @@ -28865,7 +28315,7 @@ paths: type: array items: *40 examples: - default: *212 + default: *206 headers: Link: *38 x-github: @@ -29049,9 +28499,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *207 examples: - default: *214 + default: *208 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29087,7 +28537,7 @@ paths: type: array items: *43 examples: - default: *215 + default: *209 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29270,7 +28720,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &216 + schema: &210 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -29284,7 +28734,7 @@ paths: required: - include_claim_keys examples: - default: &217 + default: &211 value: include_claim_keys: - repo @@ -29311,9 +28761,9 @@ paths: required: true content: application/json: - schema: *216 + schema: *210 examples: - default: *217 + default: *211 responses: '201': description: Empty response @@ -29358,7 +28808,7 @@ paths: schema: type: object properties: - enabled_repositories: &219 + enabled_repositories: &213 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -29372,7 +28822,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *47 - selected_actions_url: *218 + selected_actions_url: *212 required: - enabled_repositories examples: @@ -29412,7 +28862,7 @@ paths: schema: type: object properties: - enabled_repositories: *219 + enabled_repositories: *213 allowed_actions: *47 required: - enabled_repositories @@ -29426,6 +28876,195 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: *214 + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: *215 + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: *48 + examples: + default: *216 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *73 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *48 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: *217 + examples: + default: *49 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: *218 + examples: + default: *49 + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: *3 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -29460,7 +29099,127 @@ paths: type: array items: *64 examples: - default: *220 + default: &220 + 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 + allow_auto_merge: false + 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 @@ -29525,7 +29284,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - *199 + - &219 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -29548,7 +29313,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - *199 + - *219 responses: '204': description: Response @@ -29618,6 +29383,240 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - *73 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *64 + examples: + default: *220 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + - *219 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *73 + - *219 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *99 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -30114,7 +30113,7 @@ paths: type: array items: *40 examples: - default: *212 + default: *206 headers: Link: *38 x-github: @@ -30456,7 +30455,7 @@ paths: parameters: - *73 - *58 - - *199 + - *219 responses: '204': description: Response @@ -30480,7 +30479,7 @@ paths: parameters: - *73 - *58 - - *199 + - *219 responses: '204': description: Response @@ -34172,9 +34171,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -37394,6 +37393,13 @@ paths: - *279 - *280 - *281 + - name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string - *282 - *283 - *284 @@ -54474,8 +54480,8 @@ paths: application/json: schema: oneOf: - - *208 - - *209 + - *202 + - *203 '503': description: Response content: @@ -57389,7 +57395,7 @@ paths: type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *47 - selected_actions_url: *218 + selected_actions_url: *212 required: - enabled examples: @@ -57550,7 +57556,7 @@ paths: description: Response content: application/json: - schema: *194 + schema: *214 examples: default: value: @@ -57585,7 +57591,7 @@ paths: required: true content: application/json: - schema: *195 + schema: *215 examples: default: summary: Set retention days @@ -57618,7 +57624,7 @@ paths: application/json: schema: *48 examples: - default: *196 + default: *216 '404': *6 x-github: enabledForGitHubApps: true @@ -57679,7 +57685,7 @@ paths: description: Response content: application/json: - schema: *197 + schema: *217 examples: default: *49 '403': *27 @@ -57707,7 +57713,7 @@ paths: required: true content: application/json: - schema: *198 + schema: *218 examples: default: *49 responses: @@ -72448,7 +72454,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *208 + schema: *202 '403': *27 x-github: triggersNotification: true @@ -81339,7 +81345,7 @@ paths: application/json: schema: oneOf: - - *208 + - *202 - *575 x-github: githubCloudOnly: false @@ -99976,7 +99982,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *208 + schema: *202 examples: invalid_state_transition: value: @@ -111614,7 +111620,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *199 + - *219 responses: '204': description: Response @@ -111640,7 +111646,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *199 + - *219 responses: '204': description: Response @@ -116983,10 +116989,10 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *247 - - *200 - - *201 - - *202 - - *203 + - *194 + - *195 + - *196 + - *197 responses: '200': description: Response when getting a billing usage report @@ -166592,6 +166598,8 @@ webhooks: type: string title: type: string + title_html: + type: string duration: type: - number @@ -166600,6 +166608,8 @@ webhooks: type: - string - 'null' + completed: + type: boolean required: - id - title diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 41abcb4ca5..db4e3726a3 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -13845,653 +13845,6 @@ "deprecated": true } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { - "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "days": 90, - "maximum_allowed_days": 365 - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - }, - "examples": { - "application/json": { - "value": { - "days": 100 - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "summary": "Set approval policy to first time contributors", - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { - "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" - }, - "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { - "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/self-hosted-runners-settings" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", - "enum": [ - "all", - "selected", - "none" - ] - } - } - }, - "examples": { - "application/json": { - "value": { - "enabled_repositories": "all" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { - "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/repository-paginated" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "selected_repository_ids" - ], - "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" - } - } - }, - "examples": { - "application/json": { - "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -16042,6 +15395,313 @@ } } }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/repositories": { "get": { "summary": "List selected repositories enabled for GitHub Actions in an organization", @@ -16315,6 +15975,346 @@ } } }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/self-hosted-runners-settings" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] + } + } + }, + "examples": { + "application/json": { + "value": { + "enabled_repositories": "all" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + "get": { + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "selected_repository_ids" + ], + "properties": { + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" + } + } + }, + "examples": { + "application/json": { + "value": { + "selected_repository_ids": [ + 1, + 2, + 3 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + "put": { + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", @@ -20959,9 +20959,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -23793,6 +23793,9 @@ { "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" + }, { "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" }, @@ -126814,27 +126817,6 @@ "updated_at" ] }, - "self-hosted-runners-settings": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" - } - } - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -127476,6 +127458,27 @@ "enabled_repositories" ] }, + "self-hosted-runners-settings": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + } + } + }, "runner-groups-org": { "type": "object", "properties": { @@ -162453,6 +162456,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -162464,6 +162470,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -306269,136 +306278,6 @@ "updated_at": "2022-07-04T22:20:11Z" } }, - "repository-paginated": { - "value": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - } - ] - } - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -306587,6 +306466,136 @@ "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } }, + "repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "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 + } + ] + } + }, "runner-groups-org": { "value": { "total_count": 3, @@ -332767,7 +332776,7 @@ }, "enterprise": { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -333513,6 +333522,14 @@ "type": "integer" } }, + "dependabot-alert-comma-separated-artifact-registry-urls": { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, "alert-dismissal-reviewer-name": { "name": "reviewer", "description": "Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.", diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 513e39bce2..c1d5d9f911 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -9759,458 +9759,6 @@ paths: category: orgs subcategory: custom-roles deprecated: true - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: - "$ref": "#/components/schemas/basic-error" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/self-hosted-runners-settings" - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer - repositories: - type: array - items: - "$ref": "#/components/schemas/repository" - examples: - default: - "$ref": "#/components/examples/repository-paginated" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -11420,6 +10968,218 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -11618,6 +11378,246 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/self-hosted-runners-settings" + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/repository" + examples: + default: + "$ref": "#/components/examples/repository-paginated" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -15033,9 +15033,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -17199,6 +17199,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" @@ -91801,23 +91802,6 @@ components: - organization - created_at - updated_at - self-hosted-runners-settings: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners can be - used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -92318,6 +92302,23 @@ components: "$ref": "#/components/schemas/selected-actions-url" required: - enabled_repositories + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be + used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization runner-groups-org: type: object properties: @@ -117667,6 +117668,8 @@ components: type: string title: type: string + title_html: + type: string duration: type: - number @@ -117675,6 +117678,8 @@ components: type: - string - 'null' + completed: + type: boolean required: - id - title @@ -225609,127 +225614,6 @@ components: description: A great organization created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:20:11Z' - repository-paginated: - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - 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 - allow_auto_merge: false - 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 dependabot-repository-access-details: value: default_level: public @@ -225897,6 +225781,127 @@ components: 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 + 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 + allow_auto_merge: false + 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 runner-groups-org: value: total_count: 3 @@ -248324,8 +248329,7 @@ components: type: string enterprise: name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -248993,6 +248997,14 @@ components: required: true schema: type: integer + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string alert-dismissal-reviewer-name: name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 41abcb4ca5..db4e3726a3 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -13845,653 +13845,6 @@ "deprecated": true } }, - "/organizations/{org}/actions/permissions/artifact-and-log-retention": { - "get": { - "summary": "Get artifact and log retention settings for an organization", - "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "days": 90, - "maximum_allowed_days": 365 - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set artifact and log retention settings for an organization", - "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-artifact-and-log-retention-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - }, - "examples": { - "application/json": { - "value": { - "days": 100 - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { - "get": { - "summary": "Get fork PR contributor approval permissions for an organization", - "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set fork PR contributor approval permissions for an organization", - "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - }, - "examples": { - "default": { - "summary": "Set approval policy to first time contributors", - "value": { - "approval_policy": "first_time_contributors" - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { - "get": { - "summary": "Get private repo fork PR workflow settings for an organization", - "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set private repo fork PR workflow settings for an organization", - "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", - "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - }, - "examples": { - "default": { - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - } - } - } - } - }, - "responses": { - "204": { - "description": "Empty response for successful settings update" - }, - "403": { - "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners": { - "get": { - "summary": "Get self-hosted runners settings for an organization", - "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/get-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/self-hosted-runners-settings" - }, - "examples": { - "response": { - "summary": "Example response", - "value": { - "enabled_repositories": "selected", - "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" - } - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set self-hosted runners settings for an organization", - "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-permissions-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used in the organization", - "enum": [ - "all", - "selected", - "none" - ] - } - } - }, - "examples": { - "application/json": { - "value": { - "enabled_repositories": "all" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { - "get": { - "summary": "List repositories allowed to use self-hosted runners in an organization", - "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/repository-paginated" - } - } - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set repositories allowed to use self-hosted runners in an organization", - "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "selected_repository_ids" - ], - "properties": { - "selected_repository_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "IDs of repositories that can use repository-level self-hosted runners" - } - } - }, - "examples": { - "application/json": { - "value": { - "selected_repository_ids": [ - 1, - 2, - 3 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { - "put": { - "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", - "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "delete": { - "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", - "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", - "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/repository-id" - } - ], - "responses": { - "204": { - "description": "No content" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - } - }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -16042,6 +15395,313 @@ } } }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/repositories": { "get": { "summary": "List selected repositories enabled for GitHub Actions in an organization", @@ -16315,6 +15975,346 @@ } } }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/self-hosted-runners-settings" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] + } + } + }, + "examples": { + "application/json": { + "value": { + "enabled_repositories": "all" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + "get": { + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "selected_repository_ids" + ], + "properties": { + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" + } + } + }, + "examples": { + "application/json": { + "value": { + "selected_repository_ids": [ + 1, + 2, + 3 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + "put": { + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", @@ -20959,9 +20959,9 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, - "maxItems": 1000, + "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." @@ -23793,6 +23793,9 @@ { "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" + }, { "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" }, @@ -126814,27 +126817,6 @@ "updated_at" ] }, - "self-hosted-runners-settings": { - "type": "object", - "required": [ - "enabled_repositories" - ], - "properties": { - "enabled_repositories": { - "type": "string", - "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", - "enum": [ - "all", - "selected", - "none" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" - } - } - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -127476,6 +127458,27 @@ "enabled_repositories" ] }, + "self-hosted-runners-settings": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + } + } + }, "runner-groups-org": { "type": "object", "properties": { @@ -162453,6 +162456,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -162464,6 +162470,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -306269,136 +306278,6 @@ "updated_at": "2022-07-04T22:20:11Z" } }, - "repository-paginated": { - "value": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "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 - } - ] - } - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -306587,6 +306466,136 @@ "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } }, + "repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "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 + } + ] + } + }, "runner-groups-org": { "value": { "total_count": 3, @@ -332767,7 +332776,7 @@ }, "enterprise": { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -333513,6 +333522,14 @@ "type": "integer" } }, + "dependabot-alert-comma-separated-artifact-registry-urls": { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of Artifact Registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, "alert-dismissal-reviewer-name": { "name": "reviewer", "description": "Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.", diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 513e39bce2..c1d5d9f911 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -9759,458 +9759,6 @@ paths: category: orgs subcategory: custom-roles deprecated: true - "/organizations/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-artifact-and-log-retention" - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-contributor-approval" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" - examples: - default: - "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: - "$ref": "#/components/schemas/basic-error" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/self-hosted-runners-settings" - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer - repositories: - type: array - items: - "$ref": "#/components/schemas/repository" - examples: - default: - "$ref": "#/components/examples/repository-paginated" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/repository-id" - responses: - '204': - description: No content - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -11420,6 +10968,218 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -11618,6 +11378,246 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/self-hosted-runners-settings" + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-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: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/repository" + examples: + default: + "$ref": "#/components/examples/repository-paginated" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -15033,9 +15033,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. - Up to 1000 IDs can be provided. + Up to 250 IDs can be provided. minItems: 1 - maxItems: 1000 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -17199,6 +17199,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" @@ -91801,23 +91802,6 @@ components: - organization - created_at - updated_at - self-hosted-runners-settings: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners can be - used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -92318,6 +92302,23 @@ components: "$ref": "#/components/schemas/selected-actions-url" required: - enabled_repositories + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be + used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization runner-groups-org: type: object properties: @@ -117667,6 +117668,8 @@ components: type: string title: type: string + title_html: + type: string duration: type: - number @@ -117675,6 +117678,8 @@ components: type: - string - 'null' + completed: + type: boolean required: - id - title @@ -225609,127 +225614,6 @@ components: description: A great organization created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:20:11Z' - repository-paginated: - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - 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 - allow_auto_merge: false - 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 dependabot-repository-access-details: value: default_level: public @@ -225897,6 +225781,127 @@ components: 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 + 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 + allow_auto_merge: false + 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 runner-groups-org: value: total_count: 3 @@ -248324,8 +248329,7 @@ components: type: string enterprise: name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -248993,6 +248997,14 @@ components: required: true schema: type: integer + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: A comma-separated list of Artifact Registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string alert-dismissal-reviewer-name: name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 4d26402e10..23139c2540 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -34322,7 +34322,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34395,7 +34395,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34470,7 +34470,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34542,7 +34542,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34623,7 +34623,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34700,7 +34700,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34893,7 +34893,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34962,7 +34962,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35005,7 +35005,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35050,7 +35050,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35120,7 +35120,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35195,7 +35195,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35263,7 +35263,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35332,7 +35332,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35514,7 +35514,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35707,7 +35707,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35827,7 +35827,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36001,7 +36001,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36046,7 +36046,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36248,7 +36248,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36326,7 +36326,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36378,7 +36378,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36432,7 +36432,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36669,7 +36669,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36747,7 +36747,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36799,7 +36799,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36861,7 +36861,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37087,7 +37087,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37208,7 +37208,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37518,7 +37518,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -38571,7 +38571,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39624,7 +39624,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39790,7 +39790,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39865,7 +39865,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40008,7 +40008,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40215,7 +40215,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40422,7 +40422,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40592,7 +40592,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40776,7 +40776,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41195,7 +41195,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -42826,7 +42826,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -42958,7 +42958,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -43074,7 +43074,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -45021,7 +45021,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46477,7 +46477,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46661,7 +46661,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -457923,7 +457923,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -458480,7 +458480,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -459089,7 +459089,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -459624,7 +459624,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -460294,7 +460294,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -460954,7 +460954,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -461334,7 +461334,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -461981,7 +461981,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -462866,7 +462866,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -463494,7 +463494,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -464335,7 +464335,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -465149,7 +465149,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -922462,6 +922462,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -922473,6 +922476,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ @@ -922536,6 +922542,9 @@ "title": { "type": "string" }, + "title_html": { + "type": "string" + }, "duration": { "type": [ "number", @@ -922547,6 +922556,9 @@ "string", "null" ] + }, + "completed": { + "type": "boolean" } }, "required": [ diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml index 74f8cc2439..7eb5ade8fd 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml @@ -10298,8 +10298,7 @@ paths: parameters: - &63 name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -141394,6 +141393,8 @@ webhooks: type: string title: type: string + title_html: + type: string duration: type: - number @@ -141402,6 +141403,8 @@ webhooks: type: - string - 'null' + completed: + type: boolean required: - id - title diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json index 4d26402e10..23139c2540 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json @@ -34322,7 +34322,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34395,7 +34395,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34470,7 +34470,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34542,7 +34542,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34623,7 +34623,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34700,7 +34700,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34893,7 +34893,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -34962,7 +34962,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35005,7 +35005,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35050,7 +35050,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35120,7 +35120,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35195,7 +35195,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35263,7 +35263,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35332,7 +35332,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35514,7 +35514,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35707,7 +35707,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -35827,7 +35827,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36001,7 +36001,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36046,7 +36046,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36248,7 +36248,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36326,7 +36326,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36378,7 +36378,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36432,7 +36432,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36669,7 +36669,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36747,7 +36747,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36799,7 +36799,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -36861,7 +36861,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37087,7 +37087,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37208,7 +37208,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -37518,7 +37518,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -38571,7 +38571,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39624,7 +39624,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39790,7 +39790,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -39865,7 +39865,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40008,7 +40008,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40215,7 +40215,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40422,7 +40422,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40592,7 +40592,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -40776,7 +40776,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -41195,7 +41195,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -42826,7 +42826,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -42958,7 +42958,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -43074,7 +43074,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -45021,7 +45021,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46477,7 +46477,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -46661,7 +46661,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -457923,7 +457923,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -458480,7 +458480,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -459089,7 +459089,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -459624,7 +459624,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -460294,7 +460294,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -460954,7 +460954,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -461334,7 +461334,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -461981,7 +461981,7 @@ "parameters": [ { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -462866,7 +462866,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -463494,7 +463494,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -464335,7 +464335,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -465149,7 +465149,7 @@ }, { "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { @@ -922462,6 +922462,9 @@ "title": { "type": "string" {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}